Skip to main content

Documentation

Retrieve Document of Payout

Retrieve details of a supporting document file that was previously uploaded to a specific payout.

Parameters

Request Path Parameters

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

- file_id
- ID of the specific document file. UUID.

Request Header Parameters

Response Parameters

/v1/payouts/:payout/documents/:file_id

Retrieve Document of Payout

curl -X get
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 'idempotency: your-idempotency-parameter-here'
-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": "411b1685-fec6-42cb-8cde-02eca47f5c4r"
    },
    "data": [
        {
            "payout_token": "payout_548969fc5a0bf89da3cec70a1529338d",
            "file_id": "e0b0ef98-2fac-4dcd-86c7-e1062bfd1c55",
            "file_name": "Driver-license.jpg",
            "file_extension": "jpg",
            "created_ad": "2024-10-30 07:55:36"
        }
    ]
}

In this section: