CClearPayz

Developer Documentation

One API. Every rail.

Integrate settlement, virtual accounts, card issuing, on/off ramps, and compliance through a single API surface. Sandbox credentials in minutes. Production-ready from day one.

bash · Create payout
curl https://api.clearpayz.com/v1/payouts \
  -H "Authorization: Bearer sk_live_..." \
  -d amount=50000 \
  -d currency=USDT \
  -d destination[country]=AE
Coming soonAPI keys — launching soon
Get notified

RESTful API

JSON over HTTPS with predictable resource-oriented endpoints and comprehensive error codes.

Webhooks

Real-time event notifications for transfers, payments, card transactions, and verification status.

Sandbox

Full sandbox environment with test credentials. Mirror production behaviour without moving real funds.

Guides

Step-by-step integration guides for every product — from first API call to production launch.

Quick start

Your first API call.

Authentication
# All requests require a Bearer token
curl https://api.clearpayz.com/v1/balance \
  -H "Authorization: Bearer sk_test_..."

# Base URLs
# Sandbox:  https://sandbox-api.clearpayz.com/v1
# Production: https://api.clearpayz.com/v1
Create a transfer
curl -X POST https://api.clearpayz.com/v1/transfers \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "1000.00",
    "currency": "USDC",
    "source_corridor": "IN",
    "destination_corridor": "AE",
    "beneficiary": {
      "name": "Test Beneficiary",
      "account": "AE070331234567890123456"
    }
  }'

Webhooks

Stay in sync with events.

Webhook payload example
{
  "id": "evt_a1b2c3d4",
  "type": "transfer.completed",
  "created_at": "2026-05-24T10:30:00Z",
  "data": {
    "transfer_id": "trf_xyz789",
    "amount": "1000.00",
    "currency": "USDC",
    "status": "completed",
    "source_corridor": "IN",
    "destination_corridor": "AE",
    "settled_at": "2026-05-24T10:30:45Z"
  }
}

# Verify webhook signatures
# Header: X-ClearPayz-Signature
# Algorithm: HMAC-SHA256 with your webhook secret

SDKs

Official client libraries.

Node.jsStable
PythonStable
GoBeta
RubyBeta
Install (Node.js)
npm install @clearpayz/sdk

import { ClearPayz } from '@clearpayz/sdk';

const client = new ClearPayz('sk_test_...');
const balance = await client.balance.retrieve();

Ready to build?

Get sandbox credentials and start integrating in minutes.