Glossary

Access token — A short-lived bearer credential that authenticates you and names the user you act for. Valid 60 minutes; obtained from a signed client assertion. See Authentication.

Client assertion — The RS256-signed JWT you exchange for an access token. It proves you hold the private key whose public half we have on file.

User — Your customer, identified by email. One access token acts for exactly one user, and that user must pass KYC before they can transact.

KYC — The user's identity verification. Its status gates order reviews and order creation. See KYC.

Quote — A preview of the crypto cost, the fee, and the accepted amount range for a payout. It reserves nothing unless you lock it. A locked quote holds its rate and fees for five minutes and can be used for one order.

Order — A payout you create. It debits your fund and settles asynchronously; track it by its status. See Scan-to-Pay & Cashout.

orderId — The unique id you assign to an order. It doubles as the idempotency key — reusing one is rejected rather than paying twice.

Fund — Your crypto balance held with us. Topped up by sending crypto to its deposit addresses, drawn down by orders, and itemised in its ledger.

Bank — A payout destination available for a given fiat currency. The set differs per service and changes over time, so fetch it rather than hard-coding it.

Account resolution — A lookup that returns the account-holder name registered against a bank account number, so you can confirm the recipient before paying them.

Scan-to-Pay — Paying a merchant your user scanned, by QR code or bank account.

Cashout — Paying fiat out to a recipient's bank account directly.