Balance API

Retrieve your Opn Payments account balances. All amounts are expressed in the smallest currency unit.


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.

at string

The account balance at a certain time. For example, if the balance is 1000, with the at field as 12PM, it indicates that the balance at 12PM is 1000.

created_at string

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

currency string

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.


  • JSON Response

Retrieve the balance


Returns the current balance of the account.


  • Retrieve the balance

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