Skip to content
Bank Payouts / Request a payout / Get bank account field formatting

Get bank account field formatting

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