Upload Documents to Payout
Upload one supporting document file or multiple document files to a specific payout. These documents include ID scans, company registrations, and all other documents that support the validity of the payout. A file can be uploaded only when the payout is in a Created, Hold, or Pending status.
payout
ID of the payout. String starting with payout_.
file
Use the
-For--formparameter to define the path to the document file on your local machine. Supported file types include '*.pdf', '*.doc', '*.docx', '.*csv', '*.jpeg', '*.jpg', '*.gif', '*.png'. Format of input must follow themultipart/form-dataprotocol. Use thefilesparameter to upload multiple files.Nota
* Maximum number of files that can be uploaded in one request is 10.
* Maximum size of files that can be uploaded in one request is 20 MB.
* Document file name should be up to 200 characters long.
None.
The following parameters are returned for each file that was uploaded.
/v1/files/documents/payout/:payout
Upload File to Payout
curl -X post 'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_548969fc5a0bf89da3cec70a1529338d' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: multipart/form-data' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ -F 'file=@"/your-file-location/file.jpg"'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "411b1685-fec6-42cb-8cde-02eca47f5c4d" }, "data": [ { "payout_token": "payout_548969fc5a0bf89da3cec70a1529338d", "file_id": "e0b0ef98-2fac-4dcd-86c7-e1062bfd1c55", "file_name": "file.jpg", "file_extension": "jpg", "created_at": "2024-10-30 07:55:36" } ] }
Upload Multiple Files to Payout
curl -X post 'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_548969fc5a0bf89da3cec70a1529338d' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: multipart/form-data' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ -F 'file=@"/your-file-location/License.jpg"' \ -F 'file=@"/your-file-location/Company_registration.jpg"'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "fab397ad-93c3-4b8b-a2f0-dbfb23447524" }, "data": [{ "payout_token": "payout_548969fc5a0bf89da3cec70a1529338d", "file_id": "4260335d-1081-4c2f-b523-397aa30e50ff", "file_name": "License.jpg", "file_extension": "jpg", "created_at": "2024-11-12 09:52:33" }, { "payout_token": "payout_548969fc5a0bf89da3cec70a1529338d", "file_id": "4fbb1942-dbbb-436a-8ed3-76524bc4b4b1", "file_name": "Company_registration.jpg", "file_extension": "jpg", "created_at": "2024-11-12 09:52:33" }] }
Bad Request - Upload Document Not Provided
curl -X post 'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_a7885752f09567e0f7e508bae27ab29b' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: multipart/form-data' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ -F 'file=@""'
{ "status": { "error_code": "ERROR_UPLOAD_DOCUMENT_NOT_PROVIDED", "status": "ERROR", "message": "The request attempted to upload a document, but no document file was provided. The request was rejected. Corrective action: Rerun the request with a valid document file.", "response_code": "ERROR_UPLOAD_DOCUMENT_NOT_PROVIDED", "operation_id": "0c8cf66f-6810-4dfa-bc96-cc20044766e5" } }
Bad Request - Unsupported File Type
curl -X post 'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_a7885752f09567e0f7e508bae27ab29b' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: multipart/form-data' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ -F 'file=@"/your-file-location/file.xml"'
{ "status": { "error_code": "ERROR_UPLOAD_FILE_UNSUPPORTED_FILE_TYPE", "status": "ERROR", "message": "The request tried to upload a file, but the file type was not supported. The request was rejected. Corrective action: Upload a file that is of a supported file type.", "response_code": "ERROR_UPLOAD_FILE_UNSUPPORTED_FILE_TYPE", "operation_id": "0c8cf66f-6810-4dfa-bc96-cc20044766e5" } }
Unauthorized
curl -X post 'https://sandboxapi.rapyd.net/v1/files/documents/payout/payout_af69206aec6c2a22327f774f08d4ae32' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: multipart/form-data' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ -F 'file=@"/your-file-location/file.jpg"'
{ "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": "115dca64-4d12-4065-9ae4-55ddd1d84563" } }