Delete Document of Payout
Delete a document file that was previously uploaded to a specific payout.
payout
ID of the payout. String starting with payout_.
file_id
ID of the specific document file. UUID.
Response returns a success status with no data object.
/v1/payouts/:payout/documents/:file_id
Delete Document of Payout
curl -X delete 'https://sandboxapi.rapyd.net/v1/payouts/payout_548969fc5a0bf89da3cec70a1529338d/documents/e0b0ef98-2fac-4dcd-86c7-e1062bfd1c55' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "1e1fd62c-e3d9-433d-ab1a-2f60b4765af2" } }
Bad Request - Payout Not Found
curl -X delete 'https://sandboxapi.rapyd.net/v1/payouts/payout_548969fc5a0bf89da3cec70a1529338d/documents/e03b791d-1784-4dec-94db-f664131dedbb' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "ERROR_GET_PAYOUT", "status": "ERROR", "message": "The request tried to retrieve a payout, but the payout was not found. The request was rejected. Corrective action: Use the ID of a valid payout.", "response_code": "ERROR_GET_PAYOUT", "operation_id": "a332e292-d8ea-46f2-a4e3-b3ac3458e2c6" } }
Unauthorized
curl -X delete 'https://sandboxapi.rapyd.net/v1/payouts/payout_548969fc5a0bf89da3cec70a1529338d/documents/e0b0ef98-2fac-4dcd-86c7-e1062bfd1c55' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "UNAUTHENTICATED_API_CALL", "status": "ERROR", "message": "The request was rejected due to an authentication issue. Corrective action: Check the status of your account in the 'Account Details' page of the Client Portal.", "response_code": "UNAUTHENTICATED_API_CALL", "operation_id": "14b02645-8f48-4f24-b523-3aebda91da4e" } }