> ## 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 locking in the exchange rate. Returns a crypto deposit address and a quotation ID valid for a fixed time window.
Integrate the DollarPe Create Payout Quotation endpoint into my application.
Endpoint: POST /payout/quotation
Base URL: [https://api.dollarpe.in](https://api.dollarpe.in) (production) | [https://sandbox.dollarpe.in](https://sandbox.dollarpe.in) (sandbox)
Auth headers required on every request:
* X-API-KEY: your API key
* X-TIMESTAMP: current Unix time in seconds
* X-SIGNATURE: Base64(HMAC-SHA256(X-API-KEY + X-TIMESTAMP + sortedJSONBody, apiSecret))
Payout quotation flow:
1. POST /payout/quotation → get quotation\_id and crypto deposit address
2. Customer sends crypto to the returned deposit address
3. POST /payout/initiate → create the order (link to quotation\_id)
4. Poll GET /payout/{payout_id} or listen to webhooks for status updates
Note: If this call returns 400 "EDD required", collect EDD information from the customer and submit it via POST /ren/api/v1/payout/edd/save before retrying.
Task: Write a typed function that:
1. Accepts customer\_id, crypto\_asset, fiat\_currency, and amount
2. Builds the signed auth headers
3. Calls POST /payout/quotation
4. Returns quotation\_id, crypto deposit address, locked rate, and expiry time
5. Handles 400 (EDD required, customer unverified, unsupported pair) and 500 errors
Language: TypeScript
UPI is not currently supported for payouts.
Provide exactly one of `sending_amount` (crypto amount to send) or `receiving_amount` (fixed fiat amount the beneficiary should receive) — not both. For remittance payouts, use the dedicated [Remittance Quotation](/api-reference-exchange/endpoint/remittance-payout/quotation) endpoint instead.
## Error Codes and Messages
| API Status Code | Response | Reason |
| --------------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| 400 | Customer is unverified | Customer is added but KYC is unverified |
| 400 | Customer is unverified | Customer does not belong to Organization |
| 400 | Bank account is unverified | Bank account is not added |
| 400 | Bank account is unverified | Bank account is added but under processing |
| 400 | Bank account is unverified | Name mismatch between PAN and Bank account |
| 400 | Bank account is unverified | Bank account is linked to some other customer |
| 400 | UPI is not supported | UPI payout is currently not supported |
| 400 | Entered amount is less than minimum transaction amount | Entered amount must be greater than INR 2500 |
| 400 | Entered amount exceeds maximum transaction amount | Entered amount must be less than:
• INR 500,000 for IMPS |
| 400 | AML SCREENING FAILED | Customer appears in sanction lists and the Politically Exposed Persons (PEP) database and/or has material adverse media |
| 400 | EDD required | Suspicious activity or Red Flag Indicator is triggered |
| 400 | EDD required | Transaction milestone since last EDD is reached^ |
| 400 | EDD required | Annual EDD is due or overdue |
| 400 | Daily offramp limit exhausted | Daily offramp limit exhausted |
| 500 | Internal Server Error | Internal Server Error |
| 503 | Service unavailable | Unexpected Error Occurred |
## OpenAPI
````yaml POST /payout/quotation
openapi: 3.1.0
info:
title: DollarPe API
description: API for DollarPe - Customer, Payout, and Webhook services
license:
name: MIT
version: 1.0.0
servers:
- url: https://sandbox.dollarpe.xyz/pos/api/v1
description: Payout API Base URL
variables:
base_url:
default: https://sandbox.dollarpe.xyz
- url: https://sandbox.dollarpe.xyz/cms/api/v1
description: Customer API Base URL
variables:
base_url:
default: https://sandbox.dollarpe.xyz
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/quotation:
post:
tags:
- Payout
description: Create a quotation for cryptocurrency to fiat conversion
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- asset
- fiat
- customer_id
- bank_id
- 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: >-
The crypto amount to be sent. Mutually exclusive with
receiving_amount — provide exactly one.
example: '51'
receiving_amount:
type: string
description: >-
The fixed fiat amount the beneficiary should receive.
Mutually exclusive with sending_amount — provide exactly
one. Used for remittance payouts where the recipient amount
is fixed.
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
device_id:
type: string
suspicious_activity_report:
type: boolean
example: false
law_enforcement_agency_report:
type: boolean
example: false
responses:
'200':
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
format: uuid
example: 2e104290-07c8-49f1-a5ca-0d27f0078f8a
customer_id:
type: string
format: uuid
example: def8b740-99f9-4cba-bc9e-99de57e927b4
bank_id:
type: string
format: uuid
example: 4e6f1b20-a73c-11ec-b909-0242ac120002
asset:
type: string
example: USDT
fiat:
type: string
example: INR
sending_amount:
type: number
format: float
example: 51
rate:
type: number
format: float
example: 82.5
receiving_amount:
type: number
format: float
example: 4144.6
fees:
type: object
properties:
client_fee_fiat:
type: number
format: float
example: 450
client_fee_crypto:
type: number
format: float
example: 5
dollarpe_fee:
type: number
format: float
example: 450
pg_fee:
type: number
format: float
example: 18
client_gst_fiat:
type: number
format: float
example: 81
client_gst_crypto:
type: number
format: float
example: 0.9
dollarpe_gst:
type: number
format: float
example: 81
pg_gst:
type: number
format: float
example: 81
tds:
type: number
format: float
example: 889.17
gross_effective_exchange_rate:
type: number
format: float
example: 88.92
created_at:
type: string
format: date-time
example: '2025-03-08T07:31:11.163005Z'
expiry_time:
type: string
format: date-time
example: '2025-03-08T07:36:11.163005Z'
'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.dollarpe.xyz/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
````