---
title: "Retrieve Document of Payout"
source_url: https://docs.rapyd.net/en/retrieve-document-of-payout.html
lang: en
---

# Retrieve Document of Payout

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

> **Note:**
>
> The code samples include successful requests (200), bad requests (400), and an unauthorized request (401).
>
> For a list of all error messages that appear due to bad requests, see:
>
> - [Document Errors](https://docs.rapyd.net/en/document-errors.md "Document Errors")
> - [Payout Errors](https://docs.rapyd.net/en/payout-errors.md "Payout Errors")
> - [General Errors](https://docs.rapyd.net/en/general-errors.md "General Errors")

### 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

- - access_key
  - Unique access key provided by Rapyd for each authorized user.

    See [Developers](https://docs.rapyd.net/en/developers.md "Developers").
- - Content-Type
  - Indicates that the data appears in JSON format. Set to **application/json**.
- - salt
  - Random string. Recommended length: 8-16 characters.
- - signature
  - Signature calculated for each request individually.

    See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures").
- - timestamp
  - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds).

### Response Parameters

- - payout_token
  - ID of the payout. String starting with **payout_**.
- - file_id
  - ID of the uploaded file. UUID.
- - file_name
  - The name of the document file.
- - file_extension
  - The uploaded file's extension.
- - created_at
  - The date and time when the file was successfully uploaded. Format is **YYYY-MM-DD HH:MM:SS**.

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

- Retrieve Document of Payout
- ```curl
  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'
  ```
- ```json
  {
      "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"
      }
  }
  ```

- Bad Request - Document Deleted or Does Not Exist
- ```curl
  curl -X get
  'https://sandboxapi.rapyd.net/v1/payouts/payout_af69206aec6c2a22327f774f08d4ae32/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'
  ```
- ```json
  {
      "status": {
          "error_code": "ERROR_DOCUMENT_PREVIOUSLY_DELETED_OR_DOES_NOT_EXIST",
          "status": "ERROR",
          "message": "The request attempted to retrieve a document, but the file was previously deleted or does not exist.  The request was rejected. Corrective action: None.",
          "response_code": "ERROR_DOCUMENT_PREVIOUSLY_DELETED_OR_DOES_NOT_EXIST",
          "operation_id": "ac60a5e3-e55a-432a-8d28-3ffb8bae7ffe"
      }
  }
  ```

- Bad Request - Payout Not Found
- ```curl
  curl -X get
  'https://sandboxapi.rapyd.net/v1/payouts/payout_548969fc5a0bf89da3cec70a1529338d/documents/4fbb1942-dbbb-436a-8ed3-76524bc4b4b1' \
  -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'
  ```
- ```json
  {
      "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": "5e057ed5-4afe-4013-8fbd-8c84e071081f"
      }
  }
  ```

- Unauthorized
- ```curl
  curl -X get
  'https://sandboxapi.rapyd.net/v1/payouts/payout_548969fc5a0bf89da3cec70a1529338d/documents/4fbb1942-dbbb-436a-8ed3-76524bc4b4b1' \
  -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'
  ```
- ```json
  {
      "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": "a4cf841b-b006-47a1-ad57-e4e32e278550"
      }
  }
  ```