Skip to main content
GET
Check Merchant Balance

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Query Parameters

date
string

Get balance at Datetime in UTC timezone. Follows the Datetime ISO.

Example:

"2020-10-15T12:16:26.128Z"

currency
string

Three-letter ISO currency code.

Example:

"XOF"

accountType
enum<string>[]

Restrict the response to specific accounts. Repeat the parameter or pass a comma-separated list, e.g. ?accountType=collection&accountType=cross-border or ?accountType=collection,cross-border. Omit it to get every account the merchant holds.

Available options:
collection,
transfer,
transfer-irt,
cross-border
Example:

Response

collectionAccount
object[]

Collection account balance(s). Absent when the merchant holds no collection account, or when accountType excludes it.

transferAccount
object[]

Transfer account balance(s). Absent when the merchant holds no transfer account, or when accountType excludes it.

transferIrtAccount
object[]

IRT Transfer account balance(s). Absent when the merchant holds no IRT transfer account, or when accountType excludes it.

crossBorderAccount
object[]

Cross-border float balance(s) — the funds backing cross-border payouts. Derived from the event-sourced cross-border account: availableBalance already excludes the float reserved by transactions still in flight, which is reported separately as reservedBalance. A currency whose balance has fallen back to zero is still returned, so a zero balance can be told apart from a currency that was never funded. Absent when the merchant holds no cross-border account, or when accountType excludes it.