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.

Parameters

Request Path Parameters

- payout
- ID of the payout. String starting with payout_.

Request Header Parameters

Request Input File

- file
- Use the -F or --form parameter 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 the multipart/form-data protocol. Use the files parameter to upload multiple files.
  Note
  * 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.

Request Body Parameters

None.

Response Parameters

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="@/path/of/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_ad": "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 'files=@"/your-file-location/License.jpg" 
-F 'files=@"/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_ad": "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_ad": "2024-11-12 09:52:33"
	}]
}

In this section:

Documentation