Quickstart

DollarPe provides a comprehensive suite of APIs that enables businesses to offer fiat-to-crypto (onramp) and crypto-to-fiat (offramp) services to their customers. By managing the intricacies of cryptocurrency transactions, KYC compliance, and banking processes, our solution enables you to deliver smooth onramp and offramp experiences while staying focused on your core operations.

Integration Journey

As a DollarPe partner, your integration journey involves these key steps:

Partner Integration Flow

The typical partner integration flow follows these steps:

flowchart TD
    Start([Start Integration]) --> Auth[Set Up API Authentication]
    Auth --> Webhook[Configure Webhooks for
    Notifications]

    Webhook --> KYC[Implement Customer KYC Flow]
    KYC --> KYCVerified{KYC Verified?}

    KYCVerified -->|No| HandleKYCFailure[Handle KYC Failure]
    HandleKYCFailure --> KYC

    KYCVerified -->|Yes| AddBank[Add Customer Bank Account]
    AddBank --> BankVerified{Bank Verified?}

    BankVerified -->|No| HandleBankFailure[Handle Bank Verification Failure]
    HandleBankFailure --> AddBank

    BankVerified -->|Yes| FlowType{Choose Flow}

    FlowType -->|Payout| PayoutFlow[Fetch Payout Configurations]
    PayoutFlow --> FetchRate[Fetch Current Exchange Rate]
    FetchRate --> CreateQuote[Create Payout Quotation]
    CreateQuote --> InitiatePayout[Initiate Fiat Payout]
    InitiatePayout --> MonitorStatus[Monitor Payout Status]
    MonitorStatus --> Complete([Integration Complete])

    FlowType -->|PayIn| PayInFlow[Fetch PayIn Configurations]
    PayInFlow --> FetchPayInRate[Fetch PayIn Exchange Rate]
    FetchPayInRate --> CreatePayInQuote[Create PayIn Quotation]
    CreatePayInQuote --> SendFiat[Send Fiat to Bank Details]
    SendFiat --> InitiatePayIn[Initiate PayIn Transaction]
    InitiatePayIn --> MonitorPayInStatus[Monitor PayIn Status]
    MonitorPayInStatus --> Complete

    classDef startEndNode fill:#dcedc8,stroke:#558b2f,stroke-width:1px,color:#000,font-size:12px
    classDef mainNode fill:#e3f2fd,stroke:#1976d2,stroke-width:1px,color:#000,font-size:12px
    classDef decisionNode fill:#f3e5f5,stroke:#8e24aa,stroke-width:1px,color:#000,font-size:12px
    classDef successNode fill:#e8f5e9,stroke:#2e7d32,stroke-width:1px,color:#000,font-size:12px
    classDef failureNode fill:#ffebee,stroke:#c62828,stroke-width:1px,color:#000,font-size:12px

    class Start,Complete startEndNode
    class Auth,Webhook,KYC,AddBank,PayoutFlow,FetchRate,CreateQuote,InitiatePayout,MonitorStatus,PayInFlow,FetchPayInRate,CreatePayInQuote,SendFiat,InitiatePayIn,MonitorPayInStatus mainNode
    class KYCVerified,BankVerified,FlowType decisionNode
    class HandleKYCFailure,HandleBankFailure failureNode

    linkStyle default stroke:#64748b,stroke-width:1px;

Key Integration Components

1. API Authentication

Secure your API requests to our platform using our authentication system:

// Example authentication header setup
const crypto = require("crypto");

/**
 * Generates authentication headers for DollarPe API requests.
 * @param {string} apiKey - Your partner API key.
 * @param {string} apiSecret - Your partner API secret.
 * @param {Object} [body={}] - The request body.
 * @returns {Object} - The headers object containing authentication details.
 */
const generateHeaders = (apiKey, apiSecret, body = {}) => {
  // Get current timestamp
  const timestamp = Math.floor(Date.now() / 1000);

  // Sort and stringify the body
  const sortedBody = JSON.stringify(body, Object.keys(body).sort());

  // Create message string
  const message = `${apiKey}|${timestamp}|${sortedBody}`;

  // Generate signature
  const signature = crypto
    .createHmac("sha256", apiSecret)
    .update(message)
    .digest("base64");

  return {
    "Content-Type": "application/json",
    "X-API-KEY": apiKey,
    "X-TIMESTAMP": timestamp.toString(),
    "X-SIGNATURE": signature,
  };
};

2. Customer KYC Integration

Implement our KYC flow to verify your customers' identities:

3. PayIn Service Integration

Connect to our payin system to enable fiat-to-crypto transfers:

4. Payout Service Integration

Connect to our payout system to enable crypto-to-fiat transfers: