Skip to main content
An account holds money in one currency. You can hold several accounts in the same currency, for example “Operations” and “Payroll” in GBP. Scopes: accounts:read to list, accounts:write to open.

Open an account

The default account

The first account you open in a currency becomes that currency’s default (isDefault: true). Card payments from checkout in that currency land in the default account. Payment links and invoices name their own receiving account.

Read balances

GET /v1/accounts returns every account with three balances:
Show available as the balance: it’s posted minus what outgoing payments have reserved (pending). See Money. The response also has totals, one entry per currency, adding up the accounts that resolved.

Unresolved accounts

Rarely, an account can’t be read accurately. It’s still listed, so you know it exists, but with status: "unresolved", a reason, and no amounts. Leave it out of any total and try again later. unresolved at the top level counts them.

Receive money by bank transfer

Where an account can receive bank transfers, it carries deposit: the details a payer sends money to.
  • Render fields in order using each label. The fields differ by currency: an account number and sort code for GBP, an IBAN and BIC for EUR.
  • status: "pending" means the details are being set up and can’t receive money yet. fields is absent until they’re ready.
  • No deposit means the account doesn’t receive bank transfers. It can still hold money and pay out.
Money that arrives is credited to the account automatically.