CHcheckout
Instruments

Get bank account field formatting

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

get/validation/bank-accounts/{country}/{currency}

Request

Path parameters

countrystring required

The two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">ISO country code</a>

currencystring required

The three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="_blank">ISO currency code</a>

Query parameters

account-holder-type'individual' | 'corporate' | 'government'

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

payment-network'local' | 'sepa' | 'fps' | 'ach' | 'fedwire' | 'swift'

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

Response

Bank account fields retrieved successfully

Example response

{
  "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
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.