> ## 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.
# Create Quotation
> Creates a payout quotation funded from your prefunded balance.
Integrate the Zapyd prefunded payout Create Quotation endpoint into my application.
Endpoint: POST /pos/api/v1/prefunded/payout/quotation
Base URL: [https://sandbox.zapyd.com](https://sandbox.zapyd.com) (sandbox) | [https://api.zapyd.com](https://api.zapyd.com) (production)
Full URL (sandbox): POST [https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/quotation](https://sandbox.zapyd.com/pos/api/v1/prefunded/payout/quotation)
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 asset, fiat, payment\_method, exactly one of sending\_amount or receiving\_amount, customer\_id, bank\_id and risk\_parameters (no network: the prefunded wallet network is used)
2. Builds the signed auth headers
3. Calls POST /pos/api/v1/prefunded/payout/quotation
4. Returns quotation id, rate, amounts, fees and expiry\_time
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 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 in which the payout will
be maid
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
````