Balance API

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

Attribute

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

The transferable amount which is the total minus funds "on hold" and funds in reserve (reserve_amount).

currency string

The currency expressed as its lower-cased international 3-letter code defined by the ISO 4217 standard (see supported currencies by country).

reserve_amount integer

Funds that are being reserved (note: reserve feature must be enabled).

total integer

Total balance after deducted fees.

Example

  • Json Response

Retrieve the balance

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

Returns the balance object of the current account.

Example

  • Retrieve the balance