Account API

Retrieve information about an account. Note: both test and live keys return the same account.

Attributes

Name	Type	Description
object	string	The string `account`.
id	object_id	The account identifier matching `/account(_test)?_[0-9a-z]+/`.
livemode	boolean	Whether this is a live (`true`) or test (`false`) account.
location	string	API path to retrieve the current `account` object.
api_version	string	Default API version for account. Note: this version can be overridden for a given request in the header.
auto_activate_recipients	boolean	Whether to automatically activate recipients upon creation.
chain_enabled	boolean	Whether account chaining is enabled.
chain_return_uri	string	URI to which submerchant is redirected after they have authorized you (the master merchant) to make API calls on their behalf.
country	string	Country in which account is registered as two-letter ISO 3166 code.
created_at	datetime	UTC datetime of account creation in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
currency	currency	Currency for account as three-letter ISO 4217 code.
email	string	Account email address.
metadata_export_keys	object	Object specifying the metadata keys to include in exports.
supported_currencies	array	Currencies supported for credit and debit card charges by the country in which the account was registered. Enable multi-currency to use currencies other than your account currency.
team	string	The account team identifier matching `/acct(_test)?_[0-9a-z]+/`. Teams are used to grant access to the account to other individuals and give them further administrative and/or technical roles by editing their profiles.
webhook_uri	string	URI to which account events are pushed. See Webhooks and Events.
zero_interest_installments	boolean	Whether merchant absorbs the interest for installment payments.

Example

JSON Response

{
  "object": "account",
  "id": "account_test_no1t4tnemucod0e51mo",
  "team": "acct_no1t4tnemucod0e51mo",
  "livemode": false,
  "location": "/account",
  "country": "TH",
  "currency": "THB",
  "email": "somchai.prasert@example.com",
  "created_at": "2019-12-31T12:59:59Z",
  "supported_currencies": [
    "THB",
    "JPY",
    "USD",
    "EUR",
    "GBP",
    "SGD",
    "AUD",
    "CHF",
    "CNY",
    "DKK",
    "HKD"
  ],
  "api_version": "2019-05-29",
  "auto_activate_recipients": true,
  "chain_enabled": false,
  "zero_interest_installments": true,
  "chain_return_uri": "https://dashboard.omise.co/test/settings",
  "webhook_uri": "https://omise-flask-example.herokuapp.com/webhook",
  "metadata_export_keys": {
    "charge": [
      "color",
      "order_id"
    ]
  },
  "chaining_allowed": true,
  "last_updated_api_version": "2019-06-06",
  "transfer_config": {
    "min_transfer_amount": "30.00",
    "max_transfer_amount": 2000000,
    "is_payout_enabled": false
  }
}

Retrieve account information

- GET https://api.omise.co/account

Returns information about the account.

Example

Retrieve the account

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/account \
  -u $OMISE_SECRET_KEY:

<?php

$account = OmiseAccount::retrieve();

// After retrieving it, the account can be refreshed:
$account->reload();

const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const account = await omise.account.retrieve();
console.log(account);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

account = Omise::Account.retrieve

# After retrieving it, the account can be refreshed:
account.reload

var account = await Client.Account.Get();
Console.WriteLine($"account: {account.Email}");

Request<Account> request = new Account.GetRequestBuilder().build();
Account account = client().sendRequest(request);

System.out.printf("Account id: %s", account.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

account = omise.Account.retrieve()

# After retrieving it, the account can be refreshed:
account.reload()

client, _ := omise.NewClient(
	"pkey_test_no1t4tnemucod0e51mo",
	"skey_test_no1t4tnemucod0e51mo",
)

result := &omise.Account{}
err := client.Do(result, &operations.RetrieveAccount{})
if err != nil {
	log.Fatalln(err)
}
log.Println(result)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Account.retrieve

Update account information

- PATCH https://api.omise.co/account

Updates and returns information about the account.

Request Parameters

Name	Type	Description
chain_enabled	boolean	(optional) Whether account chaining is enabled.
chain_return_uri	string	(optional) URI to which submerchant is redirected after they have authorized you (the master merchant) to make API calls on their behalf.
metadata_export_keys	object	(optional) Object specifying the metadata keys to include in exports.
webhook_uri	string	(optional) URI to which account events are pushed. See Webhooks and Events.
zero_interest_installments	boolean	(optional) Whether merchant absorbs the interest for installment payments.

Example

Updates the account

curl
php
node.js
ruby
C#
java
python
go
elixir

curl https://api.omise.co/account \
  -X PATCH \
  -u $OMISE_SECRET_KEY: \
  -d "metadata_export_keys[charge][]=color" \
  -d "metadata_export_keys[charge][]=order_id" \
  -d "webhook_uri=https://omise-flask-example.herokuapp.com/webhook"

<?php

$account = OmiseAccount::retrieve();

$account->update(['webhook_uri' => 'https://www.omise.co']);

// After retrieving it, the account can be refreshed:
$account->reload();

const omise = require('omise')({
  secretKey: 'skey_test_no1t4tnemucod0e51mo',
});

const account = omise.account.UpdateAccount({ webhook_uri: 'https://webhook-url' });
console.log(account);

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

Omise.webhook_uri = "https://webhook-url"

account = Omise::Account.update

# After updating it, the account can be refreshed:
account.reload

var account = await Client.Account.Update("https://webhook-url");
Console.WriteLine($"account: {account.Id}");

Account account = client.account().update("https://webhook-url");
System.out.printf("Updated account id: %s\n", account.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

omise.webhook_uri = "https://webhook-url"

account = omise.Account.update()

# After updating it, the account can be refreshed:
account.update()

account := &omise.UpdateAccount{
	webhook_uri: "https://webhook-url"
}

if e := client.Do(account, &operations.UpdateAccount{}); e != nil {
	log.Fatalln(e)
}

log.Println("Updated account:", account)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.configure(webhook_uri: 
"https://webhook-url")

Omise.Account.update