Skip to main content

Documentation

Retrieve Document of Payout

Retrieve details of a supporting 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.

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

  • Retrieve Document of Payout

  • curl -X get
    'https://sandboxapi.rapyd.net/v1/payouts/payout_af69206aec6c2a22327f774f08d4ae32/documents/6de28b3a-09f3-413e-94e0-14780548c6ae' \
    -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": "477cc094-51c8-4a62-b0a0-f3d06027dfbd"
        },
        "data": {
            "payout_token": "payout_af69206aec6c2a22327f774f08d4ae32",
            "file_id": "6de28b3a-09f3-413e-94e0-14780548c6ae",
            "file_name": "Mass Payout - ua_general_card.csv",
            "file_extension": "csv",
            "created_at": "2025-10-15T07:48:38.000Z"
        }
    }