Balance API

Retrieve your Omise 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.

available integer

Amount available to be transferred.

currency currency_lowercase

Currency for balance as three-letter ISO 4217 code.

reserve_amount integer

Amount reserved.

total integer

Total balance after deducted fees.


  • 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