Skip to main content

Introduction

The Crypto Payment Gateway lets your application accept cryptocurrency deposits and send withdrawals over a signed REST + webhooks interface. This site is the integrator-facing reference.

What the API does​

  • Allocate deposit addresses on demand for each user / order / invoice.
  • Detect and credit deposits as they confirm on-chain, then sweep them to your hot wallet.
  • Send withdrawals to user-supplied destinations with idempotent retries.
  • Read balances and transaction history in a single envelope-shaped JSON response.
  • Push events — deposit.detected, deposit.confirmed, deposit.swept, withdrawal.broadcasted, withdrawal.confirmed, withdrawal.failed — to webhook URLs you register, with HMAC-signed bodies and a retry policy.

Networks supported at launch: EVM family (ETH / BSC / Polygon), Tron, with Solana planned. Currencies are admin-configurable per network.

End-to-end flow​

You authenticate every request with HMAC-SHA256. The gateway resolves chain-specific work to per-network microservices, persists deposit / withdrawal lifecycle in its ledger, and fans events out to whichever webhook URLs you've registered.

How this site is organised​

  • Getting Started — obtain an API key, sign your first request, understand the error envelope and rate limits.
  • Reference — every /v1 endpoint with request/response schemas and worked code samples in curl, Python, Node.js, and PHP. (Coming next.)
  • Webhooks — the six events the gateway emits, the signed envelope shape, retry policy, and signature-verification recipes. (Coming next.)

If you're integrating for the first time, work top-to-bottom through Getting Started — by the end of the Authentication page you'll have a working signed request hitting GET /v1/_ping and a 200 OK in your terminal.