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:
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 withstatus: "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 carriesdeposit: the details a payer sends money to.
- Render
fieldsin order using eachlabel. 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.fieldsis absent until they’reready.- No
depositmeans the account doesn’t receive bank transfers. It can still hold money and pay out.