/v1/customers/{customer}/bank_accountsWhen you create a new credit card, you must specify a customer or recipient on which to create it.
If the card’s owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should update the customer to have a new default_source.
| Name | Description |
|---|---|
| customer* |
| Field | Type | Description |
|---|---|---|
| alipay_account | string | A token returned by Stripe.js representing the user’s Alipay account details. |
| bank_account | object | string | Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details. |
| card | object | string | A token, like the ones returned by Stripe.js. |
| expand | array<string> | Specifies which fields in the response should be expanded. |
| metadata | object | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
| source | string | Please refer to full documentation instead. |
anyOf option 1: account
| Field | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| business_profile | account_business_profile | Business information about the account. | |||||||||||||||
| business_type | string | The business type. | |||||||||||||||
| capabilities | account_capabilities | ||||||||||||||||
| charges_enabled | boolean | Whether the account can process charges. | |||||||||||||||
| company | legal_entity_company | ||||||||||||||||
| controller | account_unification_account_controller | ||||||||||||||||
| country | string | The account's country. | |||||||||||||||
| created | integer (unix-time) | Time at which the account was connected. Measured in seconds since the Unix epoch. | |||||||||||||||
| default_currency | string | Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country. | |||||||||||||||
| details_submitted | boolean | Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details. | |||||||||||||||
| string | An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. | ||||||||||||||||
| external_accounts | object | External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where 4 nested fields
| |||||||||||||||
| future_requirements | account_future_requirements | ||||||||||||||||
| groups | account_group_membership | The groups associated with the account. | |||||||||||||||
| id* | string | Unique identifier for the object. | |||||||||||||||
| individual | person | ||||||||||||||||
| metadata | object | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | |||||||||||||||
| object* | string | String representing the object's type. Objects of the same type share the same value. | |||||||||||||||
| payouts_enabled | boolean | Whether the funds in this account can be paid out. | |||||||||||||||
| requirements | account_requirements | ||||||||||||||||
| settings | account_settings | Options for customizing how the account functions within Stripe. | |||||||||||||||
| tos_acceptance | account_tos_acceptance | ||||||||||||||||
| type | string | The Stripe account type. Can be |
anyOf option 2: bank_account
| Field | Type | Description |
|---|---|---|
| account | string | account | The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an External Account where controller.is_controller is |
| account_holder_name | string | The name of the person or business that owns the bank account. |
| account_holder_type | string | The type of entity that holds the account. This can be either |
| account_type | string | The bank account type. This can only be |
| available_payout_methods | array<string> | A set of available payout methods for this bank account. Only values from this set should be passed as the |
| bank_name | string | Name of the bank associated with the routing number (e.g., |
| country* | string | Two-letter ISO code representing the country the bank account is located in. |
| currency* | string (currency) | Three-letter ISO code for the currency paid out to the bank account. |
| customer | string | customer | deleted_customer | The ID of the customer that the bank account is associated with. |
| default_for_currency | boolean | Whether this bank account is the default external account for its currency. |
| fingerprint | string | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. |
| future_requirements | external_account_requirements | Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when. |
| id* | string | Unique identifier for the object. |
| last4* | string | The last four digits of the bank account number. |
| metadata | object | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| object* | string | String representing the object's type. Objects of the same type share the same value. |
| requirements | external_account_requirements | Information about the requirements for the bank account, including what information needs to be collected. |
| routing_number | string | The routing transit number for the bank account. |
| status* | string | For bank accounts, possible values are |
anyOf option 3: card
| Field | Type | Description |
|---|---|---|
| account | string | account | |
| address_city | string | City/District/Suburb/Town/Village. |
| address_country | string | Billing address country, if provided when creating card. |
| address_line1 | string | Address line 1 (Street address/PO Box/Company name). |
| address_line1_check | string | If |
| address_line2 | string | Address line 2 (Apartment/Suite/Unit/Building). |
| address_state | string | State/County/Province/Region. |
| address_zip | string | ZIP or postal code. |
| address_zip_check | string | If |
| allow_redisplay | string | This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. |
| available_payout_methods | array<string> | A set of available payout methods for this card. Only values from this set should be passed as the |
| brand* | string | Card brand. Can be |
| country | string | Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. |
| currency | string (currency) | Three-letter ISO code for currency in lowercase. Must be a supported currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an External Account where controller.is_controller is |
| customer | string | customer | deleted_customer | The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. |
| cvc_check | string | If a CVC was provided, results of the check: |
| default_for_currency | boolean | Whether this card is the default external account for its currency. This property is only available for accounts where controller.requirement_collection is |
| dynamic_last4 | string | (For tokenized numbers only.) The last four digits of the device account number. |
| exp_month* | integer | Two-digit number representing the card's expiration month. |
| exp_year* | integer | Four-digit number representing the card's expiration year. |
| fingerprint | string | Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* |
| funding* | string | Card funding type. Can be |
| id* | string | Unique identifier for the object. |
| iin | string | Issuer identification number of the card. |
| last4* | string | The last four digits of the card. |
| metadata | object | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| name | string | Cardholder name. |
| networks | token_card_networks | |
| object* | string | String representing the object's type. Objects of the same type share the same value. |
| regulated_status | string | Status of a card based on the card issuer. |
anyOf option 4: source
| Field | Type | Description |
|---|---|---|
| ach_credit_transfer | source_type_ach_credit_transfer | |
| ach_debit | source_type_ach_debit | |
| acss_debit | source_type_acss_debit | |
| alipay | source_type_alipay | |
| allow_redisplay | string | This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. |
| amount | integer | A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for |
| au_becs_debit | source_type_au_becs_debit | |
| bancontact | source_type_bancontact | |
| card | source_type_card | |
| card_present | source_type_card_present | |
| client_secret* | string | The client secret of the source. Used for client-side retrieval using a publishable key. |
| code_verification | source_code_verification_flow | |
| created* | integer (unix-time) | Time at which the object was created. Measured in seconds since the Unix epoch. |
| currency | string (currency) | Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for |
| customer | string | The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. |
| eps | source_type_eps | |
| flow* | string | The authentication |
| giropay | source_type_giropay | |
| id* | string | Unique identifier for the object. |
| ideal | source_type_ideal | |
| klarna | source_type_klarna | |
| livemode* | boolean | If the object exists in live mode, the value is |
| metadata | object | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| multibanco | source_type_multibanco | |
| object* | string | String representing the object's type. Objects of the same type share the same value. |
| owner | source_owner | Information about the owner of the payment instrument that may be used or required by particular source types. |
| p24 | source_type_p24 | |
| receiver | source_receiver_flow | |
| redirect | source_redirect_flow | |
| sepa_debit | source_type_sepa_debit |