Overview
What the Partner API does, who it is for, and the shortest possible integration path.
Private, invite-only. Small surface: every endpoint is one signed POST, every webhook is one signed event. A self-serve cabinet lives at /partner/login. /api/v1/create accepts an Idempotency-Key so retries are safe. See Authentication for the signing rules.
New here? Start at the Quickstart: first signed call, first order, first webhook in five minutes.
Two integration models
- Server-to-server API. Sign every request, control price quoting and idempotency, receive signed webhooks. Start at the Quickstart.
- Referral links. Send traffic at
/r/{code}with the swap direction in the URL. No backend integration; earnings accrue automatically. See Referral links.
How it fits together
- Discovery. /api/v1/currencies and /api/v1/pairs. Unauthenticated; served from a 30-second cache.
- Quoting. /api/v1/price. Unauthenticated; recomputed per request against live rates.
- Order lifecycle. /api/v1/create to open, /api/v1/order to poll, /api/v1/emergency to resolve
status = "EMERGENCY", /api/v1/qr for a pay-in QR. - Reference codes. /api/v1/codes (POST / GET / DELETE) and
/api/v1/codes/enablefor multiple reference codes with per-code markup. Your API key and secret are always available in your cabinet. - Push contracts. Webhooks (signed, opt-in per-partner subscription) and XML rate feeds (public, unauthenticated).
- Self-service portal. Partner cabinet at
/partner/login: dashboard, orders, payout history, your keys, your referral link, and your codes.
Versioning
The wire contract is stable. Breaking changes are announced 30 days in advance to the contact email on your partner record. Backwards-compatible additions (new endpoints, new optional fields, new opt-in webhook events) land at any time and never break an existing integration.
Payout isolation
Partner credentials authorise discovery, quoting, and order creation. They cannot move funds. Payouts run on a separate service that re-verifies the on-chain deposit before broadcasting.