Balance API

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

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

Amount available to be transferred.

currency string

Currency for balance as three-letter ISO 4217 code.

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