Integration Guides
Payout (off-ramp)
Payin (on-ramp)
Webhook
Widget
cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/cms/api/v1/customer/create \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"full_name": "John Doe",
"email": "john@example.com",
"phone": "9911002211",
"alpha_3_country_code": "IND",
"client_reference_id": "test123",
"non_residence_status": true,
"residence_alpha_3_country_code": "USA"
}
'{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"client_reference_id": "test123",
"full_name": "John Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"country": "USA",
"type": "INDIVIDUAL",
"status": "UNVERIFIED",
"failure_reason": null,
"document_type": "AADHAAR"
}
}Onboarding
Create Customer
Create a new customer
POST
/
customer
/
create
cURL
curl --request POST \
--url https://sandbox.dollarpe.xyz/cms/api/v1/customer/create \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-SIGNATURE: <api-key>' \
--header 'X-TIMESTAMP: <api-key>' \
--data '
{
"full_name": "John Doe",
"email": "john@example.com",
"phone": "9911002211",
"alpha_3_country_code": "IND",
"client_reference_id": "test123",
"non_residence_status": true,
"residence_alpha_3_country_code": "USA"
}
'{
"status": true,
"message": "Success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"client_reference_id": "test123",
"full_name": "John Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"country": "USA",
"type": "INDIVIDUAL",
"status": "UNVERIFIED",
"failure_reason": null,
"document_type": "AADHAAR"
}
}Error Codes and Messages
| API Status Code | Response | Reason |
|---|---|---|
| 400 | Email already in use | Email already in use |
| 400 | Phone already in use | Phone already in use |
| 400 | Invalid country code | Invalid country code |
| 400 | Client Reference ID already exists | Client Reference ID already exists |
| 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
Full name of the customer
Example:
"John Doe"
Email address of the customer
Example:
"john@example.com"
Phone number of the customer
Example:
"9911002211"
Country code (based on nationality)
Example:
"IND"
Optional customer reference ID
Example:
"test123"
Boolean to define if the customer is a non-resident
Example:
true
Country code (based on country of residence)
Example:
"USA"
⌘I