---
title: "Get bank account field formatting"
method: GET
path: "/validation/bank-accounts/{country}/{currency}"
tags: ["Instruments"]
---

# Get bank account field formatting

`GET /validation/bank-accounts/{country}/{currency}`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/validation/bank-accounts/{country}/{currency}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `payouts:bank-details`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/validation/bank-accounts/:country/:currency/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `country` string, required
- `currency` string, required

## Query parameters

- `account-holder-type` 'individual' | 'corporate' | 'government'
- `payment-network` 'local' | 'sepa' | 'fps' | 'ach' | 'fedwire' | 'swift'

## Response `200`

Bank account fields retrieved successfully

- BankAccountFields
  - `sections` object[]
    - `name` string, required: The name of the section
    - `fields` object[]
      - `id` string, required: The field identifier
      - `section` string: The section to display the field in
      - `display` string, required: The field's display name
      - `help_text` string: The help text that explains the purpose of the field
      - `type` string, required: The type of field
      - `required` boolean, required: Whether the field is required
      - `validation_regex` string: A regular expression that can be used to validate the input of the field
      - `min_length` integer: The minimum length of the field
      - `max_length` integer: The maximum length of the field
      - `allowed_options` object[]: The allowed options for the field
        - `id` string: The option identifier
        - `display` string: The option display value
      - `dependencies` object[]: The field's dependencies
        - `field_id` string: The field identifier
        - `value` string: The value of the dependent field that match in order for this field to be displayed

## Other responses

- `401`: Unauthorized
- `404`: Fields not found
- `422`: Invalid data was sent

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)