> ## 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 Quotation
> Creates a payout quotation funded from your prefunded balance.
Add the Zapyd "Create Quotation" call (`POST /pos/api/v1/prefunded/payout/quotation`) to my backend. Creates a payout quotation funded from your prefunded balance.
* Sandbox: `POST https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/quotation`
* Production: `POST https://api.zapyd.com/pos/api/v1/prefunded/payout/quotation`
JSON body:
* `asset` (string, required): The cryptocurrency asset code. Example: `usdt`.
* `fiat` (string, required): The fiat currency code. Example: `inr`.
* `sending_amount` (string, optional): Crypto amount to send. Send exactly one of sending\_amount or receiving\_amount. Example: `51`.
* `receiving_amount` (string, optional): Fiat amount the beneficiary should receive. Send exactly one of sending\_amount or receiving\_amount. Example: `5100`.
* `customer_id` (string, uuid, required): Customer's unique identifier.
* `bank_id` (string, uuid, required): Customer's Bank's unique identifier that receives the payout.
* `risk_parameters` (object, required): Send every key listed in required\_risk\_parameters for the fiat in Fetch Configuration. Send `{}` if that list is empty.
* `payment_method` (string, required): Payout payment method, valid for the fiat (see Fetch Configuration). Example: `IMPS`.
Success: HTTP 201, `{status: true, message, data}`. `data`: `id`, `customer_id`, `bank_id`, `asset`, `fiat`, `network`, `sending_amount` (Crypto amount to send), `rate`, `receiving_amount` (Fiat amount the beneficiary receives), `fees`, `wallet_address` (Deposit address: send the crypto here), `created_at`, `expiry_time`.
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.`
* Same body as `POST /pos/api/v1/payout/quotation`, but `network` is ignored: the quotation uses your prefunded wallet's network. There's no crypto transfer per order.
* Send exactly one of `sending_amount` or `receiving_amount`. `payment_method` must match the bank account's method. `risk_parameters`: send every key the fiat's `required_risk_parameters` lists in the configuration endpoint, usually `ip_address` and `device_id` of the end user plus `suspicious_activity_report` and `law_enforcement_agency_report` (booleans). Send `{}` if the list is empty.
* Next: check `GET /pos/api/v1/payout/balance` covers `sending_amount`, then `POST /pos/api/v1/prefunded/payout/initiate` before `expiry_time`.
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 `createPrefundedQuotation` 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/quotation.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/quotation
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/quotation:
post:
tags:
- Prefunded Payout
description: >-
Create a payout quotation funded from your prefunded balance. Same body
as the standard payout quotation, except `network` is ignored: the
quotation always uses your prefunded wallet network. 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
required:
- asset
- fiat
- customer_id
- bank_id
- payment_method
- risk_parameters
properties:
asset:
type: string
description: The cryptocurrency asset code
example: usdt
fiat:
type: string
description: The fiat currency code
example: inr
sending_amount:
type: string
description: >-
Crypto amount to send. Send exactly one of sending_amount or
receiving_amount.
example: '51'
receiving_amount:
type: string
description: >-
Fiat amount the beneficiary should receive. Send exactly one
of sending_amount or receiving_amount.
example: '5100'
customer_id:
type: string
format: uuid
description: Customer's unique identifier
example: def8b740-99f9-4cba-bc9e-99de57e927b4
bank_id:
type: string
format: uuid
description: Customer's Bank's unique identifier that receives the payout
example: 4e6f1b20-a73c-11ec-b909-0242ac120002
risk_parameters:
type: object
properties:
ip_address:
type: string
example: 127.0.0.1
description: End user's IP address (IPv4 or IPv6).
device_id:
type: string
description: End user's device identifier.
suspicious_activity_report:
type: boolean
example: false
description: >-
true if you have filed a suspicious activity report on
this user.
law_enforcement_agency_report:
type: boolean
example: false
description: true if a law enforcement agency has reported this user.
description: >-
Required. Send every key listed in required_risk_parameters
for the fiat in Fetch Configuration. Send {} if that list is
empty.
payment_method:
type: string
description: >-
Payout payment method, valid for the fiat (see Fetch
Configuration).
example: IMPS
responses:
'201':
description: Quotation 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: 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
description: Crypto asset
example: USDT
fiat:
type: string
description: Fiat currency
example: INR
network:
type: string
description: Network
example: tron
sending_amount:
type: string
description: Crypto amount to send
example: '60.00'
rate:
type: string
description: Fee-inclusive rate
example: '85.00'
receiving_amount:
type: string
description: Fiat amount the beneficiary receives
example: '5100.00'
fees:
type: object
description: Fee breakdown
example:
zapyd_fee: '0.00'
client_fee: '0.00'
client_gst: '0.00'
tds: '0'
wallet_address:
type: string
description: 'Deposit address: send the crypto here'
example: TXqH4MnDw46f3yyrRwau3JF92Y1ie3pAXf
created_at:
type: string
description: ''
example: '2026-09-30T10:00:00Z'
format: date-time
expiry_time:
type: string
description: Quotation expiry
example: '2026-09-30T10:10: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
data:
type: 'null'
err_code:
type: string
example: REQ_FIELD_MISSING
errors:
type: object
additionalProperties:
type: array
items:
type: string
example:
amount:
- receiving_amount is required
'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.
'503':
description: Service unavailable
content:
application/json:
schema:
type: object
properties:
status:
type: boolean
example: false
message:
type: string
example: Service unavailable
data:
type: 'null'
err_code:
type: string
example: SYS_SERVICE_UNAVAILABLE
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.