An account is where a customer’s money lives. Every customer gets a primary account when their application is approved. Cards, payments, and beneficiaries all belong to an account, so their endpoints need the account’s id from the account list. Listing accounts is usually your first call after sign-in.

​
What an account looks like

A UK account has an account number and sort code. An EU account has an IBAN and BIC. Some accounts also carry virtual IBANs, which are what you send money from on international transfers. Every account reports two balances: the ledger total, and the available balance that can be spent right now. Show the available one to the customer. Accounts with several wallets break the balance down per wallet. Not every account supports every operation. Check accounts[].operations in program capabilities before you show a block, unblock, or close button.

​
What you can do

​
Read accounts

List accounts returns balances, bank details, and the account ids everything else needs.

​
Open another account

Open an additional account queues a new account, say a euro one next to the customer’s sterling one. Identify it by currency, or by alias if your program offers several accounts in the same currency. The account appears in the list once it’s created; poll the list rather than retrying the create.

​
Limits

Get account limits returns the single, daily, and monthly transaction limits, how much of today’s and this month’s allowance is already used, and the ceilings your program allows. Update account limits sets all three. Send every value, including the ones you aren’t changing. Nothing can be negative or above the program ceiling. For program-wide limits that apply to the customer as a whole, see customer limits.

​
Block, unblock, close

Block stops payments and blocks linked cards. A reason is required and is kept on the account’s status history. Unblock reverses it, cards included. Close is permanent and closes linked cards. It doesn’t check the balance, and a closed account can’t be reopened. A blocked account can be closed directly.

​
Proof of account

Account confirmation letter generates a PDF with the holder’s details, the bank details, and your program’s branding. It comes back in the response for you to render or download. Nothing is emailed, whatever the endpoint name suggests.