Appearance
List supported banks​
GET
/v2/payments/bulk-withdrawals/banks
Requires DISBURSEMENTS_READ, granted by PAYMENTS_READ or DISBURSEMENTS_WRITE (bundles)
Returns the banks you can pay out to, with each bank's default branch code. Send a bank's code as bank when you create withdrawals or beneficiaries.
Responses​
OK
application/json
JSON
[
{
"code": "ABSA",
"displayName": "ABSA Bank",
"defaultBranchCode": "632005",
"rtcParticipant": true
},
{
"code": "CAPITEC",
"displayName": "Capitec Bank",
"defaultBranchCode": "470010",
"rtcParticipant": false
},
{
"code": "FNB",
"displayName": "FNB/RMB",
"defaultBranchCode": "250655",
"rtcParticipant": true
}
]
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | BAD_REQUEST | A query parameter or field is invalid. |
| 403 | -16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED | Payments haven't been set up for your business yet. |
| 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.