Skip to content

Get bank account field formatting

Last updated: April 29, 2022

Returns the bank account field formatting required to create bank account instruments or perform payouts for the specified country and currency.


Get bank account fields

Use the details below to set up your request. To get a detailed view of all required and optional fields, see our API reference.

Endpoints

get

https://api.checkout.com/validation/bank-accounts/{country}/{currency}

Header parameters

HeaderValue

Authorization

required

OAuth Bearer access token

Content-Type

required

application/json

Path parameters

PathDescription

country

required

string

The two-letter ISO country code.

currency

required

string

The three-letter ISO currency code.

Query parameters

Field nameDescription

account-holder-type

optional

string (enum)

The type of account holder that will be used to filter the fields returned.

Can be one of:

  • individual
  • corporate
  • government

payment-network

optional

string (enum)

The banking network that will be used to filter the fields returned.

Can be one of:

  • local
  • sepa
  • fps
  • ach
  • fedwire
  • swift

Response example

1
{
2
"sections": [
3
{
4
"name": "Account Details",
5
"fields": [
6
{
7
"id": "iban",
8
"type": "string",
9
"display": "IBAN",
10
"description": "Number (which can contain letters) that identifies the account",
11
"section": "account",
12
"required": true,
13
"validation_regex": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,18}$",
14
"min_length": 22,
15
"max_length": 22
16
},
17
{
18
"id": "account_holder.first_name",
19
"type": "string",
20
"display": "First name",
21
"description": "The account holder's first name",
22
"section": "account",
23
"required": true
24
},
25
{
26
"id": "account_holder.last_name",
27
"type": "string",
28
"display": "First name",
29
"description": "The account holder's last name",
30
"section": "account",
31
"required": true
32
}
33
]
34
}
35
]
36
}