Appearance
Archive a beneficiary​
DELETE
/v2/payments/bulk-withdrawals/beneficiaries/{id}
Requires DISBURSEMENTS_DELETE, granted by DISBURSEMENTS_WRITE (bundles)
Archives a beneficiary so it no longer appears in the active list. Its bank and account number stay reserved: creating or paying the same recipient again restores it.
Parameters​
Path Parameters
id*
Beneficiary ID.
Type
Requiredstring
Example
"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"Format
"uuid"Responses​
No content
Samples​
Errors
| HTTP | Error | When |
|---|---|---|
| 400 | BAD_REQUEST | A query parameter or field is invalid. |
| 400 | -11INVALID_REQUEST | The beneficiary ID isn't a valid UUID. |
| 403 | -16098PAYMENTS_USER_ACCESS_NOT_CONFIGURED | Payments haven't been set up for your business yet. |
| 404 | NOT_FOUND | No active beneficiary with this ID exists on your account; it may already be archived. |
| 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.