API reference

Account

One endpoint describing the account the key acts for, and what it can be paid in right now. Read it at startup to learn the default currency and which coins to offer, instead of hard-coding them.

Endpoints

  • GET /v1/account The account behind the key, with meta.accepted_assets listing the coins it can take at this moment.

Example response

{
  "data": {
    "id": "acme", "object": "account", "type": "organization",
    "name": "Acme Holdings Ltd", "display_name": "Acme",
    "logo_url": "https://…", "website_url": "https://acme.example",
    "support_email": "[email protected]", "brand_color": "#f5b301",
    "default_currency": "EUR",
    "underpayment_tolerance": "1", "overpayment_threshold": "1",
    "created_at": "2026-01-14T09:12:04.000000Z"
  },
  "meta": { "accepted_assets": ["BTC", "LTC", "ETH"], "mode": "live" }
}

accepted_assets is empty until a payout wallet is set up, and shrinks when a coin is switched off. Creating a charge in a coin that is not listed returns 422.

underpayment_tolerance and overpayment_threshold are percentages: how far short a payment may fall and still count as paid, and how much surplus is ignored before the charge is flagged as overpaid.

default_currency is one of USD, EUR, GBP, CAD, AUD, CHF, TRY.