Introduction

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable description of the failure"
  }
}
Ways to authorize a request
CallerCredentialWhere it works
Dashboard sessionThe session JWTEvery route in this reference. It is the only option for the API key and withdrawal routes.
Your backendAn HMAC signature built from the API keyInvoices, transactions and /merchants/me. The route decides from the request itself: with a KeyId header present it checks the signature instead of the session — see Authentication.
Pages in this reference
PageWhat it covers
QuickstartYour first invoice end to end, from issuing a key to checking the payment.
ErrorsThe error envelope and every code the API returns, with the request behind each one.
AuthenticationWhat gets signed, the four signature headers, and which routes accept a signature.
API keysCreate, read, update, rotate and revoke the key your backend signs with.
WebhooksHow webhook delivery is configured today, and why a callback is not proof of payment.
InvoicesCreate, list and inspect invoices of all four types, and cancel, reactivate or delete them.
TransactionsThe transaction history, one row per business event, with filters and search.
WithdrawalsRequest a payout from your balance, confirm it by email and follow its status.
Getting an API keyThe dashboard path to a key, and the two secrets you only see once.
Preparing to accept paymentsCurrencies, payment details and payout wallets to set up before the first invoice.
An invoice in the dashboardWhat an API-created invoice looks like to the person watching the dashboard.