API for Account Balances
The API for Account Balances allows merchants to check their account balances without using Bamboo’s merchant console.
Request URL
You must invoke a GET request to the following URLs according to your needs.
- Production:
https://api.bamboopayment.com/v1/api/merchant/account/balance - Stage:
https://api.stage.bamboopayment.com/v1/api/merchant/account/balance
Authorization
In the header, the Authorization parameter must be configured by concatenating the word Basic, a space and the Private Key of the merchant.
Response example
Info
You don’t need to configure a request to invoke this API.
{
"Response": {
"Date": "2023-06-02T20:59:59-03:00",
"CurrencyCode": "UYU",
"FinalAccountingBalance": 13670.0000,
"FinalAvailableBalance": 13670.0000,
"FinalFeeBalance": 0.0,
"FinalProcessingBalance": 0.0
},
"Errors": null
}
Where:
| Parameter | Description |
|---|---|
Response → Date | Date and time when you send the request. |
Response → CurrencyCode | ISO code of the currency configured for the merchant. |
Response → FinalAccountingBalance | Total balance. |
Response → FinalAvailableBalance | Total balance available for withdraw. |
Response → FinalFeeBalance | Balance available for fees. |
Response → FinalProcessingBalance | Balance in processing. This balance will be available when the processing finishes successfully; otherwise, it is canceled. |
Errors | Errors that may appear during the execution of the API method. |
