Introduction
The Hbridge API lets you provision crypto deposit addresses for your users, detect deposits, and pay out your collected balance — net of the Hbridge fee.
Overview#
Hbridge lets you accept crypto from your end users without ever touching private keys. You provision a deposit address per user per chain, we watch the chain and confirm incoming deposits at finality, and you pay the collected balance out to your own whitelisted address.
The integration lifecycle is four steps:
- Provision a deposit address for each user, on each chain you support (see Users & addresses).
- Detect — a user sends funds; Hbridge reports the deposit as
pending, thenfinalonce it reaches finality. - Collect — final deposits add to your balance, shown net of the Hbridge fee (see Deposits & balances).
- Pay out the net balance to your whitelisted address (see Payouts).
New to the API? The Quickstart walks the whole flow end to end; Core conceptsexplains the model behind it. You'll be notified of everything above in real time via webhooks.
Base URL#
All endpoints are served under a single base URL:
https://api.hbridge.ccEvery merchant endpoint is versioned under /v1. Paths in these docs are relative to the base URL (e.g. POST /v1/users → https://api.hbridge.cc/v1/users).
Authentication#
Authenticate every request with your API key as a Bearer token. Create and manage keys in the dashboard under API keys — the secret is shown once at creation, so store it securely.
Authorization: Bearer hbridge_sk_...
Content-Type: application/jsonA missing or invalid key returns 401. Keys belong to a single merchant account and can be revoked at any time for zero-downtime rotation — issue a new key, roll it out, then revoke the old one.
Conventions#
- Requests and responses are JSON.
- Amounts are decimal strings (e.g.
"1.99"), never floats — this preserves exact precision. Always parse them with a decimal library, not native floats. - Chains are upper-case codes (
ETH,SOL,TRON, …). You can only use chains an admin has enabled for your account — see Supported chains & assets. - Key operations are idempotent: users are keyed on your
external_ref, deposits are de-duplicated on(txid, outputIndex), and payouts accept anIdempotency-Keyheader. See Errors & pagination. - Pagination is cursor-based on all list endpoints (
limit+cursor→next_cursor+has_more). See Pagination.
Supported chains & assets#
Hbridgeprovisions deposit addresses and collects on the chains below. An admin enables the specific chains for your account — provisioning a chain you aren't enabled for returns 422 chain_not_enabled.
| Chain | Code | Native coin | Tokens |
|---|---|---|---|
| Ethereum | ETH | ETH | USDC |
| Solana | SOL | SOL | — |
| Tron | TRON | TRX | — |
| Bitcoin | BTC | BTC | — |
| Polygon | POLYGON | POL | — |
| Avalanche | AVAX | AVAX | — |
Network. The API currently operates on test networks — Ethereum resolves to Sepolia. Get in touch for mainnet access.
Assets. Every enabled chain supports its native coin; token support is currently USDC on Ethereum and widens as more tokens are configured. An unsupported (chain, token) pair returns 422 unsupported_token.