Appearance
Quote fees for withdrawals​
POST
/v2/payments/bulk-withdrawals/fee-quote
Requires DISBURSEMENTS_READ, granted by PAYMENTS_READ or DISBURSEMENTS_WRITE (bundles)
Estimates the fee for a set of withdrawals before you create a batch, without saving anything. requiredTotal is the available balance your payout account needs for the payouts plus the fee.
Request Body​
application/json
JSON
{
"withdrawals": [
{
"bank": "FNB",
"amount": 12500.75
},
{
"bank": "CAPITEC",
"amount": 8000.25
}
]
}
Responses​
OK
application/json
JSON
{
"fee": "25.00",
"currency": "ZAR",
"withdrawalCount": 2,
"grossTotal": "20501.00",
"requiredTotal": "20526.00",
"feeGroups": [
{
"actionType": "FAST_WITHDRAWAL",
"withdrawalCount": 1,
"grossTotal": "12500.75"
},
{
"actionType": "REGULAR_WITHDRAWAL",
"withdrawalCount": 1,
"grossTotal": "8000.25"
}
]
}
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | -113INVALID_JSON | The body isn't valid JSON. |
| 400 | -11INVALID_REQUEST | The body is empty or a field fails validation; validationErrors lists each failing field. |
| 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.