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

Retrieve account information

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

Returns information about the account.

Example

  • Retrieve the account

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