> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapyd.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch Payout

> Returns a payout order's details and current status.

<Prompt description="Fetch Payout" actions={["cursor"]}>
  Add the Zapyd "Fetch Payout" call (`GET /pos/api/v1/payout/{payout_id}`) to my backend. Returns a payout order's details and current status.

  * Sandbox: `GET https://sandbox.zapyd.com/pos/api/v1/payout/{payout_id}`
  * Production: `GET https://api.zapyd.com/pos/api/v1/payout/{payout_id}`

  Path parameters:

  * `payout_id` (string, uuid, required): The unique identifier of the payout.

  Success: HTTP 200, `{status: true, message, data}`. `data`: `id`, `quotation_id`, `customer_id`, `bank_id`, `asset`, `network`, `fiat`, `rate`, `sending_amount`, `receiving_amount` (Fiat amount the beneficiary receives), `client_reference_id`, `fees`, `status`, `wallet_address` (Deposit address from the quotation), `transaction_hash`, `utr` (Bank reference (UTR) once paid), `failure_reason` (Set when status is FAILED), `updated_at`, `created_at`.
  Errors (`{status: false, message, err_code, errors}`):

  * 400 `Payout ID is required`: Missing Payout ID
  * 400 `Payout ID is invalid`: Invalid Payout ID
  * 500 `Internal Server Error`
    Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).

  Rules:

  * Returns `status` (`PROCESSING`, `SUCCESS`, `FAILED`, `REFUNDED`, `IN_REVIEW`), `utr` on success and `failure_reason`. Remittance payouts are read here too. Prefer webhooks. If you must poll, poll at most once a minute.

  Signing (every request):

  * Headers: `X-API-KEY`, `X-TIMESTAMP` (Unix seconds, within 300 s of server time; generate per request) and `X-SIGNATURE`.
  * `X-SIGNATURE` = Base64(HMAC-SHA256(key = API secret, message = apiKey + "|" + timestamp + "|" + canonicalBody)). Base64 of the raw digest, not hex.
  * canonicalBody: the JSON body with keys sorted at every nesting level, no whitespace (separators `,` and `:`), and every non-ASCII character escaped as lowercase `\uXXXX` (Python `json.dumps(body, sort_keys=True, separators=(",", ":"))`). Requests with no body (GET, DELETE) sign `{}`. Query parameters are not signed.
  * Send the exact canonicalBody string you signed as the request body, with `Content-Type: application/json`.
  * Test vector: key `3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d`, secret `test-secret-do-not-use`, timestamp `1735689600`. Signing `{}` gives `6sCtVSRQjU9+2/af8gdwUAvY1l6Ii6ENcbRfanPkhY0=`. Body `{"customer_id":"78c99d71-f28f-47a9-8302-93b286efbe0e","amount":100.5,"currency":"INR","meta":{"note":"Café","b":2,"a":1}}` gives `l+DvQrzlKbsOSxSYOdWoWHEehcFRZfDJPKlLDkm2cSI=`.

  Deliver:

  1. A typed `fetchPayout` function in this codebase's language and HTTP client. Reuse an existing Zapyd client and signer, or write one small shared client.
  2. Config from `ZAPYD_API_KEY`, `ZAPYD_API_SECRET` and `ZAPYD_BASE_URL`. The secret stays on the server, never in a browser or app.
  3. Return `data`. When `status` is false, throw an error with the HTTP status, `err_code`, `message` and `errors`. Don't show raw errors to end users.
  4. Retry only 429 and 5xx: exponential backoff from 1 s, capped at 30 s, at most 5 attempts.
  5. Amounts as strings. Types for every field above.
  6. Tests: the signer against the test vector, and this call against sandbox.

  Reference: `https://docs.zapyd.com/api-reference-exchange/endpoint/payout/order/{payout_id}.md`
</Prompt>

| API Status Code | Response | Reason |
| - | - | - |
| 400 | Payout ID is required. | Missing Payout ID |
| 400 | Payout ID is invalid | Invalid Payout ID |
| 500 | Internal Server Error | Internal Server Error |


## OpenAPI

````yaml GET /payout/{payout_id}
openapi: 3.1.0
info:
  title: Zapyd API
  description: API for Zapyd - Customer, Payout, and Webhook services
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox.zapyd.com/pos/api/v1
    description: Payout API Base URL
    variables:
      base_url:
        default: https://sandbox.zapyd.com
  - url: https://sandbox.zapyd.com/cms/api/v1
    description: Customer API Base URL
    variables:
      base_url:
        default: https://sandbox.zapyd.com
security:
  - ApiKeyAuth: []
    TimestampAuth: []
    SignatureAuth: []
tags:
  - name: Customer
    description: Customer related operations
    x-displayName: Customer
    x-traitTag: true
  - name: Payout
    description: Payout related operations
  - name: Webhooks
    description: Webhook related operations
  - name: Widget
    description: Hosted buy/sell widget session initialization
paths:
  /payout/{payout_id}:
    get:
      tags:
        - Payout
      description: Fetch details of a specific payout
      parameters:
        - name: payout_id
          in: path
          required: true
          description: The unique identifier of the payout
          schema:
            type: string
            format: uuid
            example: 08441dd3-8cc0-405c-932b-7fdbc8894f66
      responses:
        '200':
          description: Payout details fetched successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Payout ID
                        example: b3f1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                        format: uuid
                      quotation_id:
                        type: string
                        description: Quotation ID
                        example: 59bf60c3-e9af-40a7-9d5c-2a1aa191e769
                        format: uuid
                      customer_id:
                        type: string
                        description: Customer ID
                        example: 84737c7d-7b62-4204-80d6-80f6ecb3ceb4
                        format: uuid
                      bank_id:
                        type: string
                        description: Bank account ID
                        example: cab47575-bbcb-4294-81a3-30774104f3b6
                        format: uuid
                      asset:
                        type: string
                        example: USDT
                      network:
                        type: string
                        description: Network
                        example: tron
                      fiat:
                        type: string
                        example: INR
                      rate:
                        type: string
                        description: Fee-inclusive rate
                        example: '85.00'
                      sending_amount:
                        type: string
                        description: Crypto amount
                        example: '60.00'
                      receiving_amount:
                        type: string
                        description: Fiat amount the beneficiary receives
                        example: '5100.00'
                      client_reference_id:
                        type:
                          - string
                          - 'null'
                        example: payout-ref-001
                      fees:
                        type: object
                        description: Fee breakdown
                        example:
                          zapyd_fee: '0.00'
                          client_fee: '0.00'
                          client_gst: '0.00'
                          tds: '0'
                      status:
                        type: string
                        description: Payout status
                        example: PROCESSING
                        enum:
                          - PROCESSING
                          - SUCCESS
                          - FAILED
                          - REFUNDED
                          - IN_REVIEW
                      wallet_address:
                        type: string
                        description: Deposit address from the quotation
                        example: TXqH4MnDw46f3yyrRwau3JF92Y1ie3pAXf
                      transaction_hash:
                        type:
                          - string
                          - 'null'
                        description: On-chain funding transaction
                        example: 0x9f2c…
                      utr:
                        type:
                          - string
                          - 'null'
                        description: Bank reference (UTR) once paid
                        example: '412345678901'
                      failure_reason:
                        type:
                          - string
                          - 'null'
                        description: Set when status is FAILED
                        example: null
                      updated_at:
                        type: string
                        example: '2026-09-30T10:05:00Z'
                        format: date-time
                      created_at:
                        type: string
                        example: '2026-09-30T10:00:00Z'
                        format: date-time
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
                  data:
                    type: 'null'
                  err_code:
                    type: string
                    example: SYS_INTERNAL_ERROR
                  errors:
                    type: string
                    example: Unexpected error occurred. Please try again later.
      servers:
        - url: https://sandbox.zapyd.com/pos/api/v1
          description: Payout API Base URL
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key for authentication
    TimestampAuth:
      type: apiKey
      in: header
      name: X-TIMESTAMP
      description: Current timestamp in seconds since epoch
    SignatureAuth:
      type: apiKey
      in: header
      name: X-SIGNATURE
      description: HMAC SHA256 signature of the request encoded in Base64

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.