Integration Guides
Customer
Payout (off-ramp)
Payin (on-ramp)
Webhook
Widget
cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/pos/api/v1/payout/initiate \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"quotation_id": "2e104290-07c8-49f1-a5ca-0d27f0078f8a",
"customer_id": "def8b740-99f9-4cba-bc9e-99de57e927b4",
"exchange_order_id": "5059889123892",
"client_reference_id": "testUser123"
}
'{
"status": true,
"message": "Success",
"data": {
"id": "5b75096f-de8d-44b4-9230-d94e6948abb6",
"quotation_id": "2e104290-07c8-49f1-a5ca-0d27f0078f8a",
"customer_id": "def8b740-99f9-4cba-bc9e-99de57e927b4",
"client_reference_id": "testUser123",
"bank_id": "e75f62f0-db9e-4904-8103-d6f14f67f5dc",
"asset": "USDT",
"fiat": "INR",
"rate": 82.5,
"sending_amount": 51,
"receiving_amount": 4144.6,
"fees": {
"client_fee_fiat": 450,
"client_fee_crypto": 5,
"dollarpe_fee": 450,
"pg_fee": 18,
"client_gst_fiat": 81,
"client_gst_crypto": 0.9,
"dollarpe_gst": 81,
"pg_gst": 81,
"tds": 889.17,
"gross_effective_exchange_rate": 88.92
},
"exchange_order_id": "5059889123892",
"created_at": "2025-03-08T07:31:24.770179Z",
"status": "PROCESSING"
}
}Payout Order
Create Payout
Create a new payout using a quotation
POST
/
payout
/
initiate
cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/pos/api/v1/payout/initiate \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"quotation_id": "2e104290-07c8-49f1-a5ca-0d27f0078f8a",
"customer_id": "def8b740-99f9-4cba-bc9e-99de57e927b4",
"exchange_order_id": "5059889123892",
"client_reference_id": "testUser123"
}
'{
"status": true,
"message": "Success",
"data": {
"id": "5b75096f-de8d-44b4-9230-d94e6948abb6",
"quotation_id": "2e104290-07c8-49f1-a5ca-0d27f0078f8a",
"customer_id": "def8b740-99f9-4cba-bc9e-99de57e927b4",
"client_reference_id": "testUser123",
"bank_id": "e75f62f0-db9e-4904-8103-d6f14f67f5dc",
"asset": "USDT",
"fiat": "INR",
"rate": 82.5,
"sending_amount": 51,
"receiving_amount": 4144.6,
"fees": {
"client_fee_fiat": 450,
"client_fee_crypto": 5,
"dollarpe_fee": 450,
"pg_fee": 18,
"client_gst_fiat": 81,
"client_gst_crypto": 0.9,
"dollarpe_gst": 81,
"pg_gst": 81,
"tds": 889.17,
"gross_effective_exchange_rate": 88.92
},
"exchange_order_id": "5059889123892",
"created_at": "2025-03-08T07:31:24.770179Z",
"status": "PROCESSING"
}
}Before initiating a payout, please review our Payout Best Practices guide to ensure successful transaction processing.
Critical Warning:
- Deposits to unsupported asset/blockchain pairs will be lost
- Deposits to incorrect addresses will be lost
- These losses are permanent and non-recoverable
Error Codes and Messages
| API Status Code | Response | Reason |
|---|---|---|
| 400 | Client Reference ID already exists | Client Reference ID already exists |
| 400 | Quotation is not found | Quotation does not exist or does not belong to this organization |
| 400 | Customer ID does not match with the quotation | Customer ID mismatch between payin order and quotation |
| 400 | Quotation has expired | Quotation has expired |
| 400 | Quotation is already linked to another payout | Quotation is already linked to another payout |
| 400 | Exchange Order ID already linked to a payout that is either processing or successful | Exchange Order ID already linked to a payout that is either processing or successful |
| 500 | Internal Server Error | Internal Server Error |
Authorizations
API Key for authentication
Current timestamp in seconds since epoch
HMAC SHA256 signature of the request encoded in Base64
Body
application/json
The unique identifier of the quotation
Example:
"2e104290-07c8-49f1-a5ca-0d27f0078f8a"
The unique identifier of the customer
Example:
"def8b740-99f9-4cba-bc9e-99de57e927b4"
Order ID on the exchange
Example:
"5059889123892"
Optional client reference ID for tracking
Example:
"testUser123"
⌘I