Balance API

Attribute

Name Type Description
object string

The string balance.

livemode boolean

Whether this is a Live (true) or Test (false) balance.

location string

Path to retrieve the balance.

available integer

Available transferable balance in the smallest currency unit (e.g. satang, cent, ... )

total integer

Total balance in the smallest currency unit (e.g. satang, cent, ... )

currency string

The currency as its lower-cased international 3-letter code, defined by the ISO 4217 standard. #Supported Currencies

Example

  • Json Response

Retrieve the balance

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

Example

  • Retrieve the balance