Skip to main content
A payment scheme is the network a bank payment travels on. Its code appears in two places:
  • country.payment_schemes, from GET /countries/{id}: the schemes active in the country, the default first, which is what a bank account there can take.
  • bank_account.payment_schemes, and the payment_schemes you can send when you create a bank account: which schemes Quidkey offers for a payment transaction routed to that account.
Each entry is a link with no _link, because schemes aren’t a resource you can fetch: { "_type": "payment_scheme", "id": "faster_payments", "is_default": true }. Codes are stable, and new ones can appear, so handle a code you don’t recognise. GET /countries/{id} says which schemes a country offers, and which is its default:

Schemes on a Bank Account

When you create a bank account, leave payment_schemes out and the country’s schemes are attached, all active. An additional payment method, such as multibanco, is attached only when you name it:
A scheme the account’s country doesn’t offer answers 400 SCHEME_NOT_AVAILABLE_IN_COUNTRY, and the same scheme twice answers 400 DUPLICATE_PAYMENT_SCHEMES. An account’s schemes can’t change after it’s created. is_active says whether Quidkey offers that scheme for a payment transaction routed to the account. It has no part in how a payout reaches the account. The identifiers an account needs depend on its country, not on its schemes. See Bank account identifiers.