bank_list

An array of banks attached to this managed account.

Schema Information

Type:array

Array Items

items

Type: object

The bank account information.

nick_name

Type: string

Pattern: ^[0-9A-Za-z_-]+$

Min length: 1

Max length: 50

The user-provided short name for the user's bank account.

account_numberrequired

Type: string

Pattern: \d+

Min length: 1

Max length: 50

The bank account number.

account_typerequired

Type: string

Enum: "CHECKING", "SAVINGS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 50

The type of bank account.

currency_code

Type: string

Format: ppaas_common_currency_code_v2

Min length: 3

Max length: 3

The primary currency code of the bank account.

identifiers

Type: array

An array of instrument institute attributes. Used with the account number to uniquely identify the instrument. Value is:

For banks with IBAN information, the IBAN number.
For banks with BBAN information, the BBAN number.
For banks with both IBAN and BBAN information, the IBAN number.

Array Items

items

Type: object

The bank account ID. An ID with ROUTING_NUMBER_1 is required.

type

Type: string

Enum:

"BANK_CODE", "BI_CODE", "BRANCH_CODE", "ROUTING_NUMBER_1", "ROUTING_NUMBER_2", "ROUTING_NUMBER_3", "SWIFT_CODE", "BRANCH_CODE", "INTERMEDIARY_SWIFT_CODE", "BBAN", "BBAN_ENCRYPTED", "BBAN_HMAC", "AGGREGATOR_YODLEE"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 125

The bank account ID type.

value

Type: string

Pattern: ^[A-Za-z0-9-_.+/ =]+

Min length: 1

Max length: 125

The value of account identifier.

branch_location

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

address_line_2

Type: string

Max length: 300

The second line of the address. For example, suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

mandate

Type: object

Mandate for this bank account.

acceptedrequired

Type: boolean

Whether mandate was accepted or not.

Array Items

items

Type: object

The bank account information.

nick_name

Type: string

Pattern: ^[0-9A-Za-z_-]+$

Min length: 1

Max length: 50

The user-provided short name for the user's bank account.

account_numberrequired

Type: string

Pattern: \d+

Min length: 1

Max length: 50

The bank account number.

account_typerequired

Type: string

Enum: "CHECKING", "SAVINGS"

Pattern: ^[0-9A-Z_]+$

Min length: 1

Max length: 50

The type of bank account.

currency_code

Type: string

Format: ppaas_common_currency_code_v2

Min length: 3

Max length: 3

The primary currency code of the bank account.

identifiers

Type: array

An array of instrument institute attributes. Used with the account number to uniquely identify the instrument. Value is:

For banks with IBAN information, the IBAN number.
For banks with BBAN information, the BBAN number.
For banks with both IBAN and BBAN information, the IBAN number.

Array Items

items

Type: object

The bank account ID. An ID with ROUTING_NUMBER_1 is required.

type

Type: string

Enum:

"BANK_CODE", "BI_CODE", "BRANCH_CODE", "ROUTING_NUMBER_1", "ROUTING_NUMBER_2", "ROUTING_NUMBER_3", "SWIFT_CODE", "BRANCH_CODE", "INTERMEDIARY_SWIFT_CODE", "BBAN", "BBAN_ENCRYPTED", "BBAN_HMAC", "AGGREGATOR_YODLEE"

Pattern: ^[0-9A-Z_-]+$

Min length: 1

Max length: 125

The bank account ID type.

value

Type: string

Pattern: ^[A-Za-z0-9-_.+/ =]+

Min length: 1

Max length: 125

The value of account identifier.

branch_location

Type: object

The portable international postal address. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls: the autocomplete attribute.

address_line_1

Type: string

Max length: 300

The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.

address_line_2

Type: string

Max length: 300

The second line of the address. For example, suite or apartment number.

admin_area_2

Type: string

Max length: 120

A city, town, or village. Smaller than admin_area_level_1.

admin_area_1

Type: string

Max length: 300

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, CA and not California. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

postal_code

Type: string

Max length: 60

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.

country_coderequired

Type: string

Format: ppaas_common_country_code_v2

Pattern: ^([A-Z]{2}|C2)$

Min length: 2

Max length: 2

The two-character ISO 3166-1 code that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the C2 country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

mandate

Type: object

Mandate for this bank account.

acceptedrequired

Type: boolean

Whether mandate was accepted or not.

bank_list

Schema Information

Array Items

On this page

If you accept cookies, we'll use them to improve and customise your experience and enable our partners to show you personalised PayPal ads when you visit other sites. Manage cookies and learn more

bank_list

Schema Information

Array Items