Bank Details

The required information to add a card as a financial instrument to PayPal through onboarding.

Schema Information

Type:object

Properties

nick_name

Type: string

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

account_numberrequired

Type: string

Pattern: \d+

The bank account number. These are numeric values only without any additional formatting.

account_typerequired

Type: string

Enum: "CHECKING", "SAVINGS"

The type of account, which is checking or savings.

currency_code

Type: string

Pattern: ^([A-Z]){3}$

The primary three-character ISO-4217 currency code for the 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 attributes for an instrument institute ID. 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.

type

Type: string

Enum:

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

The bank account ID type.

value

Type: string

The bank account ID value.

branch_location

Type: object

The branch location, if applicable.

line1required

Type: string

The first line of the address. For example, number or street.

line2

Type: string

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

cityrequired

Type: string

The city name.

state

Type: string

The code for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: Argentina, Brazil, Canada, China, India, Italy, Japan, Mexico, Thailand, or United States. Maximum length is 40 single-byte characters.

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.

postal_code

Type: string

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

mandate_agreed

Type: boolean

Indicates whether the user has agreed to the mandate for financial instrument (FI) authorization.

Properties

nick_name

Type: string

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

account_numberrequired

Type: string

Pattern: \d+

The bank account number. These are numeric values only without any additional formatting.

account_typerequired

Type: string

Enum: "CHECKING", "SAVINGS"

The type of account, which is checking or savings.

currency_code

Type: string

Pattern: ^([A-Z]){3}$

The primary three-character ISO-4217 currency code for the 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 attributes for an instrument institute ID. 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.

type

Type: string

Enum:

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

The bank account ID type.

value

Type: string

The bank account ID value.

branch_location

Type: object

The branch location, if applicable.

line1required

Type: string

The first line of the address. For example, number or street.

line2

Type: string

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

cityrequired

Type: string

The city name.

state

Type: string

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.

postal_code

Type: string

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

mandate_agreed

Type: boolean

Indicates whether the user has agreed to the mandate for financial instrument (FI) authorization.

Bank Details

Schema Information

Properties

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Bank Details

Schema Information

Properties