Balance API

The Balance API allows you retrieve your Omise account balances. All amounts are expressed in the smallest currency unit.

Attributes

Name Type Description
object string

The string balance.

livemode boolean

Whether this is a live (true) or test (false) balance.

location string

API path to retrieve the current balance object.

created_at datetime

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

currency currency

Currency for balance as three-letter ISO 4217 code.

reserve integer

Amount reserved.

total integer

Total balance after deducted fees.

transferable integer

Amount available to be transferred.

Example

  • JSON Response

Retrieve the balance

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

Returns the current balance of the account.

Example

  • Retrieve the balance