> ## 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.
# Create Payout
> Creates a payout paid from your prefunded balance, with a sender and a receiver customer.
Add the Zapyd "Create Payout" call (`POST /pos/api/v1/prefunded/payout/initiate`) to my backend. Creates a payout paid from your prefunded balance, with a sender and a receiver customer.
* Sandbox: `POST https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/initiate`
* Production: `POST https://api.zapyd.com/pos/api/v1/prefunded/payout/initiate`
JSON body:
* `quotation_id` (string, uuid, required): Quotation ID from Create Quotation.
* `customer` (object, required): Sender and receiver customers. receiver.id must be the quotation's customer.
* `sender` (object, required): The customer who starts the transfer and pays for it: `{"id": "customer UUID"}`.
* `id` (string, uuid, required): Customer ID.
* `receiver` (object, required): The receiving customer, who owns the quotation and the bank account: `{"id": "customer UUID"}`.
* `id` (string, uuid, required): Customer ID.
* `client_reference_id` (string, optional): Your reference for this payout. Optional, but must be unique if sent. Example: `payout-ref-001`.
Success: HTTP 201, `{status: true, message, data}`. `data`: `id`, `quotation_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`, `customer`.
Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff).
Rules:
* Prefunded payouts must be enabled for your organization. Otherwise these endpoints return `This endpoint is not available for your organization.`
* No `transaction_hash`: Zapyd reserves `sending_amount` from your prefunded balance. Check `GET /pos/api/v1/payout/balance` first.
* `customer.receiver.id` must be the quotation's customer (who owns the bank account). `customer.sender.id` is the customer who starts the transfer and pays for it; in a cross-border payment, the customer whose payin funded it.
* The payout starts as `PROCESSING`. Track it with the `PAYOUT` webhook (no webhook for `PROCESSING`): `SUCCESS` with `metadata.utr` (show it as proof of payment), `IN_REVIEW` (send the user to `metadata.rfi_link` when present, otherwise wait), `FAILED` (always the generic `Payout failed`), `REFUNDED`. Every event carries your `client_reference_id`. Most payouts finish in 30 to 60 minutes; bank delays can take up to 24 hours.
* On a timeout or 5xx, look the payout up in `GET /pos/api/v1/prefunded/payout/history` by `client_reference_id` before retrying.
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 `createPrefundedPayout` 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/prefunded-payout/initiate.md`
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 POST /pos/api/v1/prefunded/payout/initiate
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/initiate:
post:
tags:
- Prefunded Payout
description: >-
Create a payout from a prefunded quotation. The amount is reserved from
your prefunded balance, so no `transaction_hash` is needed. Identify
both parties in `customer`: `receiver` is the customer who gets the fiat
(the quotation's customer), `sender` is the customer who starts the
transfer and pays for it (in a cross-border payment, the customer whose
payin funded it), stored for reference. Available only to organizations
with a prefunded wallet; others get `This endpoint is not available for
your organization.`
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
quotation_id:
type: string
description: Quotation ID from Create Quotation
example: 59bf60c3-e9af-40a7-9d5c-2a1aa191e769
format: uuid
customer:
type: object
properties:
sender:
type: object
properties:
id:
type: string
description: Customer ID
example: 84737c7d-7b62-4204-80d6-80f6ecb3ceb4
format: uuid
required:
- id
description: >-
Required. The customer who starts the transfer and pays
for it: {"id": ""}.
receiver:
type: object
properties:
id:
type: string
description: Customer ID
example: 84737c7d-7b62-4204-80d6-80f6ecb3ceb4
format: uuid
required:
- id
description: >-
Required. The receiving customer, who owns the quotation
and the bank account: {"id": ""}.
required:
- sender
- receiver
description: >-
Sender and receiver customers. receiver.id must be the
quotation's customer.
client_reference_id:
type: string
description: >-
Your reference for this payout. Optional, but must be unique
if sent.
example: payout-ref-001
required:
- quotation_id
- customer
responses:
'201':
description: Payout created 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
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:
quotation_id:
type: array
items:
type: string
example:
- This field is required.
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
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.