> ## 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 History > Lists your organization's payout orders, with pagination. Add the Zapyd "Fetch Payout History" call (`GET /pos/api/v1/payout/history`) to my backend. Lists your organization's payout orders, with pagination. * Sandbox: `GET https://sandbox.zapyd.com/pos/api/v1/payout/history` * Production: `GET https://api.zapyd.com/pos/api/v1/payout/history` Query parameters: * `payout_status` (string, optional): Filter payouts by status (e.g., SUCCESS, FAILED, PROCESSING). Example: `SUCCESS`. * `customer_id` (string, uuid, optional): Filter payouts by customer ID. * `start_date` (string, date, optional): Filter payouts created on or after this date (YYYY-MM-DD). Must be used together with end\_date. Example: `2025-01-01`. * `end_date` (string, date, optional): Filter payouts created on or before this date (YYYY-MM-DD). Must be used together with start\_date. Example: `2025-01-31`. * `order_by` (string, optional): Sort field; prefix with - for descending. * `page` (integer, optional): Page number. * `per_page` (integer, optional): Results per page (10–100). Success: HTTP 200, `{status: true, message, data}`. `data`: `count` (Total count of records), `next` (URL for next page), `previous` (URL for previous page), `results`. Errors (`{status: false, message, err_code, errors}`): * 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: * Paginated: `data` has `count`, `next`, `previous` and `results`. `start_date` and `end_date` (YYYY-MM-DD) apply only together. Use it for reconciliation and to recover orders after missed webhooks. 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 `fetchPayoutHistory` 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/history.md` | API Status Code | Response | Reason | | - | - | - | | 500 | Internal Server Error. | Internal Server Error | ## OpenAPI ````yaml GET /payout/history 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/history: get: tags: - Payout description: Fetch filtered list of payouts parameters: - name: payout_status in: query required: false description: Filter payouts by status (e.g., SUCCESS, FAILED, PROCESSING) schema: type: string example: SUCCESS - name: customer_id in: query required: false description: Filter payouts by customer ID schema: type: string format: uuid example: dfd8db74-2fbb-46d1-9a93-b90f156e13b4 - name: start_date in: query required: false description: >- Filter payouts created on or after this date (YYYY-MM-DD). Must be used together with end_date. schema: type: string format: date example: '2025-01-01' - name: end_date in: query required: false description: >- Filter payouts created on or before this date (YYYY-MM-DD). Must be used together with start_date. schema: type: string format: date example: '2025-01-31' - name: order_by in: query required: false description: Sort field; prefix with - for descending schema: type: string default: '-created_at' example: '-created_at' - name: page in: query required: false description: Page number schema: type: integer minimum: 1 default: 1 - name: per_page in: query required: false description: Results per page (10–100) schema: type: integer minimum: 10 maximum: 100 default: 20 responses: '200': description: Payout history fetched successfully content: application/json: schema: type: object properties: status: type: boolean example: true message: type: string example: Success data: type: object properties: count: type: integer description: Total count of records example: 1 next: type: string nullable: true description: URL for next page example: null previous: type: string nullable: true description: URL for previous page example: null results: type: array items: 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 '400': description: Bad Request content: application/json: schema: type: object properties: status: type: boolean example: false message: type: string example: Bad Request err_code: type: string example: REQ_FIELD_MISSING errors: type: object properties: date_range: type: array items: type: string example: - start_date and end_date must be used together data: type: 'null' '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.