Appearance
Get payments account balances​
GET
/v2/payments/account/balances/{type}
Requires PAYMENTS_BALANCES_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE or DISBURSEMENTS_WRITE (bundles)
Returns the balances of one of your business's payments accounts, chosen by account type and currency. The response lists every currency held in that account.
Parameters​
Path Parameters
type*
Which payments account to read: PAYOUT (pays your disbursements), COLLECTIONS (receives collections), FUNDING (receives the deposits that fund your payouts) or HOLD (holds collected funds until you convert or withdraw them). Case-insensitive.
Type
Requiredstring
Valid values
"PAYOUT""COLLECTIONS""FUNDING""HOLD"Example
"PAYOUT"Query Parameters
currency*
Currency of the account to read, e.g. ZAR.
Type
Requiredstring
Example
"ZAR"Responses​
OK
application/json
JSON
[
{
"currency": {
"shortName": "ZAR",
"symbol": "R",
"longName": "Rand"
},
"available": "125000.00",
"reserved": "0",
"total": "125000.00"
}
]
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | BAD_REQUEST | A query parameter or field is invalid. |
| 400 | -11INVALID_REQUEST | type isn't one of PAYOUT, COLLECTIONS, FUNDING or HOLD. |
| 403 | -16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED | Payments haven't been set up for your business yet. |
| 404 | NOT_FOUND | Your business has no account of this type set up for currency. |
| 500 | INTERNAL_ERROR | Unexpected error in the payments service. |
| 502 | -16097EXCHANGE_API_ERROR | The payments service failed to process the request. |
| 502 | EXCHANGE_API_ERROR | The payments service couldn't complete the request. Try again later. |
| 503 | -16099PAYMENTS_BACKEND_PROXY_DISABLED | Payments endpoints are temporarily unavailable. |
Plus the errors common to all signed endpoints.