> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dollarpe.xyz/llms.txt
> Use this file to discover all available pages before exploring further.
# Payout History
> Lists prefunded payouts with filters and pagination.
Integrate the Zapyd prefunded payout Payout History endpoint into my application.
Endpoint: GET /pos/api/v1/prefunded/payout/history
Base URL: [https://sandbox.zapyd.com](https://sandbox.zapyd.com) (sandbox) | [https://api.zapyd.com](https://api.zapyd.com) (production)
Full URL (sandbox): GET [https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/history](https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/history)
Auth headers required on every request:
* X-API-KEY: your API key
* X-TIMESTAMP: current Unix time in seconds
* X-SIGNATURE: Base64(HMAC-SHA256(key=apiSecret, data=X-API-KEY + "|" + X-TIMESTAMP + "|" + canonicalBody))
canonicalBody = request JSON with keys sorted at every nesting level, no whitespace (separators "," and ":"), non-ASCII escaped as lowercase \uXXXX. GET requests always sign "{}" (query params are not signed). Send the exact canonicalBody string as the request body. Timestamp must be within 300s of server time.
Task: Write a typed function that:
1. Accepts optional filters (payout\_status, customer\_id, start\_date, end\_date, order\_by)
2. Builds the signed auth headers (GET signs "{}")
3. Calls GET /pos/api/v1/prefunded/payout/history
4. Returns the paginated payout list
5. Handles 400 and 500 errors
Language: TypeScript
Prefunded payouts are available only to organizations with a prefunded wallet. Check your balance with [Fetch Balance](/api-reference-exchange/endpoint/remittance-payout/balance).
## OpenAPI
````yaml GET /pos/api/v1/prefunded/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:
/pos/api/v1/prefunded/payout/history:
get:
tags:
- Prefunded Payout
description: >-
List prefunded payouts with filters and pagination. Available only to
organizations with a prefunded wallet; others get `This endpoint is not
available for your organization.`
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
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
customer:
type: object
properties:
sender:
type: object
properties:
id:
type:
- string
- 'null'
format: uuid
example: 1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d
receiver:
type: object
properties:
id:
type:
- string
- 'null'
format: uuid
example: 84737c7d-7b62-4204-80d6-80f6ecb3ceb4
'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
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
````