Retrieve bank account specifications for PayoutMethods v2

Money Management

Payout Methods

Retrieve bank account specifications for PayoutMethods

Fetch the specifications for a set of countries to know which credential fields are required, the validations for each fields, and how to translate these country-specific fields to the generic fields in the PayoutMethodBankAccount type.

Learn more about calling API v2 endpoints.

Parameters

countriesarray of strings
The countries to fetch the bank account spec for.

Returns

Response attributes

objectstring, value is "v2.money_management.payout_methods_bank_account_spec"
String representing the object’s type. Objects of the same type share the same value of the object field.

countriesmap
The list of specs by country.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Error Codes

400invalid_country_code

Returned in cases where the country code requested for the bank account spec is invalid.

GET /v2/money_management/payout_methods_bank_account_spec

cURL

curl -G https://api.stripe.com/v2/money_management/payout_methods_bank_account_spec \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-03-31.preview" \
  -d countries=US

Response

{
  "object": "v2.money_management.payout_methods_bank_account_spec",
  "countries": {
    "US": {
      "fields": [
        {
          "local_name": "account_number",
          "local_name_human": {
            "localization_key": "payout_methods.bank_account.account_number",
            "content": "Account Number"
          },
          "max_length": 17,
          "min_length": 1,
          "placeholder": "000123456789",
          "stripe_name": "account_number",
          "validation_regex": "\\A\\d{1,17}\\z"
        },
        {
          "local_name": "routing_number",
          "local_name_human": {
            "localization_key": "payout_methods.bank_account.routing_number",
            "content": "Routing Number"
          },
          "max_length": 9,
          "min_length": 9,
          "placeholder": "110000000",
          "stripe_name": "routing_number",
          "validation_regex": "\\A(01|02|03|04|05|06|07|08|09|10|11|12|21|22|23|24|25|26|27|28|29|30|31|32)[0-9]{7}\\z"
        }
      ]
    }
  }
}

Retrieve bank account specifications for PayoutMethods v2

Parameters

countriesarray of strings

Returns

Response attributes

objectstring, value is "v2.money_management.payout_methods_bank_account_spec"

countriesmap

livemodeboolean