v1
latestOpenAPI 3.0.02026-07-265892227.1 KBBalance
Check Merchant Balance
Returns a summary of a merchant accounts balances (collection, transfer and transfer irt accounts) .
get/balance
Query parameters
datestring
Example:2020-10-15T12:16:26.128Z
Get balance at Datetime in UTC timezone. Follows the Datetime ISO.
currencystring
Example:XOF
Three-letter ISO currency code.
Headers
ApiKeystring 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.
MerchantIdstring 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'live' | 'sandbox' required
Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.
Response
Example response
{
"collectionAccount": [
{
"amount": 100,
"availableBalance": 100,
"currency": "XOF",
"date": "2020-10-15T12:16:26.128Z"
}
],
"transferAccount": [
{
"availableBalance": 100,
"reservedBalance": 100,
"currency": "XOF",
"date": "2020-10-15T12:16:26.128Z",
"amount": 100
}
],
"transferIrtAccount": [
{
"availableBalance": 100,
"reservedBalance": 100,
"currency": "XOF",
"date": "2020-10-15T12:16:26.128Z",
"amount": 100
}
]
}