Skip to main content

Base URL

Authentication

Send your gateway’s API key as a bearer token:
Endpoints marked public (reading a link’s checkout, creating and reading orders) need no key. See Authentication.

Conventions

  • JSON in and out, with Content-Type: application/json. Property names are camelCase.
  • Ids are UUIDs.
  • Coin amounts are strings in the coin’s smallest unit ("1612903225806451" wei), with the coin’s decimals alongside. Fields ending in Display give the same amount in whole coins, for showing to people.
  • Fiat amounts are JSON numbers in the link’s currency.
  • Times are ISO 8601 in UTC.
  • Errors are RFC 7807 problem details; branch on title. See Errors.

Endpoints