Skip to main content
This all-in-one guide walks you through integrating our fiat-to-crypto pay-in and crypto-to-fiat payout solutions into your application with speed and ease. With our APIs, you can offer your customers smooth fiat-to-crypto and crypto-to-fiat transfers — while we take care of the heavy lifting, including blockchain transactions, KYC checks, and banking infrastructure.

​
API Overview

DollarPe’s API platform offers a suite of services designed to work together, enabling a complete end-to-end payout solution:

Customer API

Create and manage customer profiles with unique identifiers.

KYC API

Handle customer verification and compliance processes.

Bank API

Manage bank account integrations for fiat payouts.

Payin API

Accept fiat deposits and convert them into cryptocurrency for your users.

Payout API

Process crypto-to-fiat conversions and initiate bank transfers.

Webhook API

Configure real-time notifications for transaction updates.

​
Getting Started

Before integrating with our API, make sure you have the following prerequisites ready:
1

Obtain API Credentials

Reach out to our support team to get your unique API Key and API Secret for authentication.
2

Choose Environment

Pick the appropriate environment based on your development phase:
  • Sandbox – For testing and development (no real funds involved)
  • Production – For live usage with real transactions
3

Set Up Authentication

Integrate our authentication system to securely authorize your API requests.
4

Configure Webhooks

Create a publicly accessible HTTPS endpoint to receive real-time updates using our webhook system.

​
Base URLs

Access DollarPe API through our dedicated environments:
​
Base URL
string
https://sandbox.dollarpe.xyz
​
API Endpoints
string
  • Customer API: https://sandbox.dollarpe.xyz/cms/api/v1
  • Payout API: https://sandbox.dollarpe.xyz/pos/api/v1
  • Payin API: https://sandbox.dollarpe.xyz/pis/api/v1
  • Webhook API: https://sandbox.dollarpe.xyz/org/api/v1
  • Widget API: https://sandbox.dollarpe.xyz/widget/api/v1
Use this environment for:
  • Development and testing
  • Integration validation
  • Simulated transactions with test networks
  • No real funds are involved
Important: Always start with the Sandbox environment for development and testing.
Move to Production only after thorough testing and validation.Sandbox and Production environments use different API credentials. Make sure to use the correct credentials for each environment.

​
Authentication

All API requests require authentication using three custom headers:
​
X-API-KEY
string
required
Your unique API key provided by DollarPe.
​
X-TIMESTAMP
integer
required
The current Unix timestamp in seconds.
​
X-SIGNATURE
string
required
An HMAC SHA256 signature of the request, encoded in Base64.
For detailed instructions on generating these headers, see our Authentication Guide.

​
Response Format

Our API follows a consistent response format across all endpoints: 
{
    "status": true,
    "message": "Success",
    "data": {
        // Response data specific to each endpoint
    }
}

​
Testing Your Integration

Before moving to production, thoroughly validate your integration in our Sandbox environment:
  1. Use your Sandbox API credentials and base URLs.
  2. Simulate the full customer flow — from user registration to successful transactions.
  3. Ensure webhook notifications are received and processed correctly.
  4. Implement status polling endpoints as a fallback mechanism in case webhooks fail.
  5. Test various error scenarios and implement robust error handling.
For a step-by-step walkthrough, check out our Sandbox Testing Guide.