Account API

Retrieve and update account information

Attributes

Name Type Description
object string

The string account

id string

The account identifier matching /acct(_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: can be overridden for a given request using 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

For account chaining, URI to which submerchant is redirected after they have authorized you (the master merchant) to make API calls on their behalf

chaining_allowed boolean

Whether account chaining is allowed

country string

Country in which account is registered as two-letter ISO 3166 code

created string

UTC datetime of account creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ)

currency string

Currency for account as three-letter ISO 4217 code

email string

Account email address

last_updated_api_version string

Last updated API version.

Note: This is an internal API field used by the dashboard.

metadata_export_keys object

Object specifying the metadata keys to include in data exports using the Dashboard

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. Different payment methods may support different currencies

transfer_config object

The configuration for fund transfer. This configuration is set on the admin dashboard for each merchant or a PSP.

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 by default. Note: can be overridden for a given charge or source by passing the zero_interest_installments parameter on charge or source creation

Example

  • JSON Response

Retrieve account information

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

Returns information about the account. Both test and live keys return the same 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, default: false, one of: true, false) Whether account chaining is enabled

chain_return_uri string

(optional) For account chaining, 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 data exports using the Dashboard

webhook_uri string

(optional) URI to which account events are pushed. See Webhooks and Events

zero_interest_installments boolean

(optional, default: false, one of: true, false) Whether merchant absorbs the interest for installment payments by default. Note: can be overridden for a given charge or source by passing the zero_interest_installments parameter on charge or source creation

Example

  • Updates the account

Update API version

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

Updates API version to the latest version (see API Versioning)

Note: This is an internal API used by the dashboard.

Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more