The External Bank Account object ​
Attributes ​
id(string) Unique identifier for the object.object(string) String representing the object’s type. Objects of the same type share the same value.account(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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 istrue.account_holder_name(string, nullable) The name of the person or business that owns the bank account.account_holder_type(string, nullable) The type of entity that holds the account. This can be eitherindividualorcompany.account_type(string, nullable) The bank account type. This can only becheckingorsavingsin most countries. In Japan, this can only befutsuortoza.available_payout_methods(array of enums, nullable) A set of available payout methods for this bank account. Only values from this set should be passed as themethodwhen creating a payout. Possible enum values:instantstandard
bank_name(string, nullable) Name of the bank associated with the routing number (e.g.,WELLS FARGO).country(string) Two-letter ISO code representing the country the bank account is located in.currency(enum) Three-letter ISO code for the currency paid out to the bank account.customer(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the customer that the bank account is associated with.default_for_currency(boolean, nullable) Whether this bank account is the default external account for its currency.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.future_requirements(object, nullable) Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when.future_requirements.currently_due(array of strings, nullable) Fields that need to be resolved to keep the external account enabled. If not resolved bycurrent_deadline, these fields will appear inpast_dueas well, and the account is disabled.future_requirements.errors(array of objects, nullable) Details about validation and verification failures forduerequirements that must be resolved.future_requirements.errors.code(enum) The code for the type of error. Possible enum values:information_missingThe requirement associated with this error is missing critical information. The associated error reason provides more details.invalid_address_city_state_postal_codeThe combination of the city, state, and postal code in the provided address could not be validated.invalid_address_cmra_addressThe address you provided appears to be associated with a mailbox or virtual address service, which we can’t accept. Please update your address to proceed.invalid_address_highway_contract_boxInvalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.invalid_address_private_mailboxInvalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.invalid_address_registered_agent_addressThe address you provided appears to be associated with a registered agent, which we can’t accept. Please update your address to proceed. If you believe this is an error, you can submit a proof of address document for review.invalid_business_profile_nameBusiness profile names must consist of recognizable words.invalid_business_profile_name_denylistedGeneric or well-known business names aren’t supported.invalid_company_name_denylistedGeneric or well-known business names aren’t supported.invalid_dob_age_over_maximumDate of birth must be within the past 120 years.invalid_dob_age_under_18Underage. Age must be at least 18.invalid_dob_age_under_minimumPerson must be at least 13 years old.invalid_product_description_lengthYour product description must be at least 10 characters.invalid_product_description_url_matchYour product description must be different from your URL.invalid_representative_countryThe representative must have an address in the same country as the company.invalid_signatorWe could not verify the professional certifying body of this document.invalid_statement_descriptor_business_mismatchThe statement descriptor must be similar to your business name, legal entity name, or URL.invalid_statement_descriptor_denylistedGeneric or well-known statement descriptors aren’t supported.invalid_statement_descriptor_lengthThe statement descriptor must be at least 5 characters.invalid_statement_descriptor_prefix_denylistedGeneric or well-known statement descriptor prefixes aren’t supported.invalid_statement_descriptor_prefix_mismatchThe statement descriptor prefix must be similar to your statement descriptor, business name, legal entity name, or URL.invalid_street_addressThe street name and/or number for the provided address could not be validated.invalid_tax_idThe provided tax ID must have 9 digitsinvalid_tax_id_formatTax IDs must be a unique set of 9 numbers without dashes or other special characters.invalid_tos_acceptanceThe existing terms of service signature has been invalidated because the account’s tax ID has changed. The account needs to accept the terms of service again. For more information, see this documentation.invalid_url_denylistedGeneric business URLs aren’t supported.invalid_url_formatURL must be formatted as https://example.com.invalid_url_web_presence_detectedBecause you use a website, app, social media page, or online profile to sell products or services, you must provide a URL for your business.invalid_url_website_business_information_mismatchThe business information on your website must match the details you provided to Stripe.invalid_url_website_emptyYour provided website appears to be empty.invalid_url_website_inaccessibleThis URL couldn’t be reached. Make sure it’s available and entered correctly or provide another.invalid_url_website_inaccessible_geoblockedYour provided website appears to be geographically blocked.invalid_url_website_inaccessible_password_protectedYour provided website appears to be password protected.invalid_url_website_incompleteYour website seems to be missing some required information. Learn about the requirementsinvalid_url_website_incomplete_cancellation_policyYour provided website appears to have an incomplete cancellation policy.invalid_url_website_incomplete_customer_service_detailsYour provided website appears to have incomplete customer service details.invalid_url_website_incomplete_legal_restrictionsYour provided website appears to have incomplete legal restrictions.invalid_url_website_incomplete_refund_policyYour provided website appears to have an incomplete refund policy.invalid_url_website_incomplete_return_policyYour provided website appears to have an incomplete refund policy.invalid_url_website_incomplete_terms_and_conditionsYour provided website appears to have incomplete terms and conditions.invalid_url_website_incomplete_under_constructionYour provided website appears to be incomplete or under construction.invalid_url_website_otherWe weren’t able to verify your business using the URL you provided. Make sure it’s entered correctly or provide another URL.invalid_value_otherAn invalid value was provided for the related field. This is a general error code.unsupported_business_typeThe business type you provided isn’t supported in this country.verification_directors_mismatchDirectors on the account don’t match government records. Update the account and upload a directorship document with current directors.verification_document_address_mismatchAddress on the account doesn’t match the verification document. Update the account and upload the document again.verification_document_address_missingThe company address was missing on the document. Upload a document that includes the address.verification_document_corruptFile seems to be corrupted or damaged. Provide a different file.verification_document_country_not_supportedDocument isn’t supported in this person’s country or region. Provide a supported verification document.verification_document_directors_mismatchDirectors on the account don’t match the document provided. Update the account to match the registration document and upload it again.verification_document_dob_mismatchThe date of birth (DOB) on the document did not match the DOB on the account. Upload a document with a matching DOB or update the DOB on the account.verification_document_duplicate_typeThe same type of document was used twice. Two unique types of documents are required for verification.verification_document_expiredThe document could not be used for verification because it has expired. If it’s an identity document, its expiration date must be after the date the document was submitted. If it’s an address document, the issue date must be within the last six months.verification_document_failed_copyDocument is a photo or screenshot. Upload the original document.verification_document_failed_greyscaleDocument seems to be in grayscale or black and white. Provide a full color photo of the document for verification.verification_document_failed_otherThe document could not be verified for an unknown reason. Ensure that the document follows the guidelines for document uploads.verification_document_failed_test_modeA test data helper was supplied to simulate verification failure. Refer to the documentation for test file tokens.verification_document_fraudulentDocument seems to be altered. This could be because it’s fraudulent.verification_document_id_number_mismatchTax ID number on the account doesn’t match the verification document. Update the account to match the verification document and upload it again.verification_document_id_number_missingThe company ID number was missing on the document. Upload a document that includes the ID number.verification_document_incompleteDocument doesn’t include required information. Make sure all pages and sections are complete.verification_document_invalidDocument isn’t an acceptable form of identification in this account’s country or region. Ensure that the document follows the guidelines for document uploads.verification_document_issue_or_expiry_date_missingDocument is missing an expiration date. Provide a document with an expiration date.verification_document_manipulatedDocument seems to be altered. This could be because it’s fraudulent.verification_document_missing_backThe back of the document is missing. Provide both sides of the document for verification.verification_document_missing_frontThe front of the document is missing. Provide both sides of the document for verification.verification_document_name_mismatchThe name on the account does not match the name on the document. Update the account to match the document and upload it again.verification_document_name_missingThe company name was missing on the document. Upload a document that includes the company name.verification_document_nationality_mismatchThe nationality on the document did not match the person’s stated nationality. Update the person’s stated nationality, or upload a document that matches it.verification_document_not_readableDocument isn’t readable. This could be because it’s blurry or dark, or because the document was obstructed.verification_document_not_signedDocument doesn’t seem to be signed. Provide a signed document.verification_document_not_uploadedDocument didn’t upload because of a problem with the file.verification_document_photo_mismatchID photo on the document doesn’t match the selfie provided by this account.verification_document_too_largeDocument file is too large. Upload one that’s 10MB or less.verification_document_type_not_supportedThe provided document type is not accepted. Ensure that the document follows the guidelines for document uploads.verification_extraneous_directorsExtraneous directors have been added to the account. Update the account and upload a registration document with current directors.verification_failed_address_matchThe address on the account could not be verified. Correct any errors in the address field or upload a document that includes the address.verification_failed_authorizer_authorityThe account authorizer is not a registered authorized representative. Refer to this support article for more information.verification_failed_business_iec_numberThe Importer Exporter Code (IEC) number on your account could not be verified. Either correct any possible errors in the company name or IEC number. Refer to the support article for accepting international payments in India.verification_failed_document_matchThe document could not be verified. Upload a document that includes the company name, ID number, and address fields.verification_failed_id_number_matchID number on the document doesn’t match the ID number provided by this account.verification_failed_keyed_identityThe person’s keyed-in identity information could not be verified. Correct any errors or upload a document that matches the identity fields (e.g., name and date of birth) entered.verification_failed_keyed_matchThe keyed-in information on the account could not be verified. Correct any errors in the company name, ID number, or address fields. You can also upload a document that includes those fields.verification_failed_name_matchThe company name on the account could not be verified. Correct any errors in the company name field or upload a document that includes the company name.verification_failed_otherVerification failed for an unknown reason. Correct any errors and resubmit the required fields.verification_failed_representative_authorityThe authority of the account representative could not be verified. Please change the account representative to a person who is registered as an authorized representative. Please refer to this support article.verification_failed_residential_addressWe could not verify that the person resides at the provided address. The address must be a valid physical address where the individual resides and cannot be a P.O. Box.verification_failed_tax_id_matchThe tax ID on the account cannot be verified by the IRS. Either correct any possible errors in the company name or tax ID, or upload a document that contains those fields.verification_failed_tax_id_not_issuedThe tax ID on the account was not recognized by the IRS. Refer to the support article for newly-issued tax ID numbers.verification_legal_entity_structure_mismatchBusiness type or structure seems to be incorrect. Provide the correct business type and structure for this account.verification_missing_directorsWe identified that your business has directors that have not been added to the account. Please add missing directors to your account.verification_missing_executivesWe have identified executives that haven’t been added on the account. Add any missing executives to the account.verification_missing_ownersWe have identified owners that haven’t been added on the account. Add any missing owners to the account.verification_rejected_ownership_exemption_reasonThe ownership exemption reason was rejected.verification_requires_additional_memorandum_of_associationsWe have identified holding companies with significant percentage ownership. Upload a Memorandum of Association for each of the holding companies.verification_requires_additional_proof_of_registrationThe uploaded document contains holding companies with significant percentage ownership. Upload a proof of registration for each of the holding companies.verification_supportabilityWe can’t accept payments for this business under the Stripe Services Agreement without additional verification, as mentioned in the prohibited and restricted businesses list.
future_requirements.errors.reason(string) An informative message that indicates the error type and provides additional details about the error.future_requirements.errors.requirement(string) The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
future_requirements.past_due(array of strings, nullable) Fields that haven’t been resolved bycurrent_deadline. These fields need to be resolved to enable the external account.future_requirements.pending_verification(array of strings, nullable) Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move toeventually_due,currently_due,past_dueoralternatives. Fields might appear ineventually_due,currently_due,past_dueoralternativesand inpending_verificationif one verification fails but another is still pending.
last4(string) The last four digits of the bank account number.metadata(object, nullable) 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.requirements(object, nullable) Information about the requirements for the bank account, including what information needs to be collected.requirements.currently_due(array of strings, nullable) Fields that need to be resolved to keep the external account enabled. If not resolved bycurrent_deadline, these fields will appear inpast_dueas well, and the account is disabled.requirements.errors(array of objects, nullable) Details about validation and verification failures forduerequirements that must be resolved.requirements.errors.code(enum) The code for the type of error. Possible enum values:information_missingThe requirement associated with this error is missing critical information. The associated error reason provides more details.invalid_address_city_state_postal_codeThe combination of the city, state, and postal code in the provided address could not be validated.invalid_address_cmra_addressThe address you provided appears to be associated with a mailbox or virtual address service, which we can’t accept. Please update your address to proceed.invalid_address_highway_contract_boxInvalid address. Your business address must be a valid physical address from which you conduct business and cannot be a Highway Contract Box.invalid_address_private_mailboxInvalid address. Your business address must be a valid physical address from which you conduct business and cannot be a private mailbox.invalid_address_registered_agent_addressThe address you provided appears to be associated with a registered agent, which we can’t accept. Please update your address to proceed. If you believe this is an error, you can submit a proof of address document for review.invalid_business_profile_nameBusiness profile names must consist of recognizable words.invalid_business_profile_name_denylistedGeneric or well-known business names aren’t supported.invalid_company_name_denylistedGeneric or well-known business names aren’t supported.invalid_dob_age_over_maximumDate of birth must be within the past 120 years.invalid_dob_age_under_18Underage. Age must be at least 18.invalid_dob_age_under_minimumPerson must be at least 13 years old.invalid_product_description_lengthYour product description must be at least 10 characters.invalid_product_description_url_matchYour product description must be different from your URL.invalid_representative_countryThe representative must have an address in the same country as the company.invalid_signatorWe could not verify the professional certifying body of this document.invalid_statement_descriptor_business_mismatchThe statement descriptor must be similar to your business name, legal entity name, or URL.invalid_statement_descriptor_denylistedGeneric or well-known statement descriptors aren’t supported.invalid_statement_descriptor_lengthThe statement descriptor must be at least 5 characters.invalid_statement_descriptor_prefix_denylistedGeneric or well-known statement descriptor prefixes aren’t supported.invalid_statement_descriptor_prefix_mismatchThe statement descriptor prefix must be similar to your statement descriptor, business name, legal entity name, or URL.invalid_street_addressThe street name and/or number for the provided address could not be validated.invalid_tax_idThe provided tax ID must have 9 digitsinvalid_tax_id_formatTax IDs must be a unique set of 9 numbers without dashes or other special characters.invalid_tos_acceptanceThe existing terms of service signature has been invalidated because the account’s tax ID has changed. The account needs to accept the terms of service again. For more information, see this documentation.invalid_url_denylistedGeneric business URLs aren’t supported.invalid_url_formatURL must be formatted as https://example.com.invalid_url_web_presence_detectedBecause you use a website, app, social media page, or online profile to sell products or services, you must provide a URL for your business.invalid_url_website_business_information_mismatchThe business information on your website must match the details you provided to Stripe.invalid_url_website_emptyYour provided website appears to be empty.invalid_url_website_inaccessibleThis URL couldn’t be reached. Make sure it’s available and entered correctly or provide another.invalid_url_website_inaccessible_geoblockedYour provided website appears to be geographically blocked.invalid_url_website_inaccessible_password_protectedYour provided website appears to be password protected.invalid_url_website_incompleteYour website seems to be missing some required information. Learn about the requirementsinvalid_url_website_incomplete_cancellation_policyYour provided website appears to have an incomplete cancellation policy.invalid_url_website_incomplete_customer_service_detailsYour provided website appears to have incomplete customer service details.invalid_url_website_incomplete_legal_restrictionsYour provided website appears to have incomplete legal restrictions.invalid_url_website_incomplete_refund_policyYour provided website appears to have an incomplete refund policy.invalid_url_website_incomplete_return_policyYour provided website appears to have an incomplete refund policy.invalid_url_website_incomplete_terms_and_conditionsYour provided website appears to have incomplete terms and conditions.invalid_url_website_incomplete_under_constructionYour provided website appears to be incomplete or under construction.invalid_url_website_otherWe weren’t able to verify your business using the URL you provided. Make sure it’s entered correctly or provide another URL.invalid_value_otherAn invalid value was provided for the related field. This is a general error code.unsupported_business_typeThe business type you provided isn’t supported in this country.verification_directors_mismatchDirectors on the account don’t match government records. Update the account and upload a directorship document with current directors.verification_document_address_mismatchAddress on the account doesn’t match the verification document. Update the account and upload the document again.verification_document_address_missingThe company address was missing on the document. Upload a document that includes the address.verification_document_corruptFile seems to be corrupted or damaged. Provide a different file.verification_document_country_not_supportedDocument isn’t supported in this person’s country or region. Provide a supported verification document.verification_document_directors_mismatchDirectors on the account don’t match the document provided. Update the account to match the registration document and upload it again.verification_document_dob_mismatchThe date of birth (DOB) on the document did not match the DOB on the account. Upload a document with a matching DOB or update the DOB on the account.verification_document_duplicate_typeThe same type of document was used twice. Two unique types of documents are required for verification.verification_document_expiredThe document could not be used for verification because it has expired. If it’s an identity document, its expiration date must be after the date the document was submitted. If it’s an address document, the issue date must be within the last six months.verification_document_failed_copyDocument is a photo or screenshot. Upload the original document.verification_document_failed_greyscaleDocument seems to be in grayscale or black and white. Provide a full color photo of the document for verification.verification_document_failed_otherThe document could not be verified for an unknown reason. Ensure that the document follows the guidelines for document uploads.verification_document_failed_test_modeA test data helper was supplied to simulate verification failure. Refer to the documentation for test file tokens.verification_document_fraudulentDocument seems to be altered. This could be because it’s fraudulent.verification_document_id_number_mismatchTax ID number on the account doesn’t match the verification document. Update the account to match the verification document and upload it again.verification_document_id_number_missingThe company ID number was missing on the document. Upload a document that includes the ID number.verification_document_incompleteDocument doesn’t include required information. Make sure all pages and sections are complete.verification_document_invalidDocument isn’t an acceptable form of identification in this account’s country or region. Ensure that the document follows the guidelines for document uploads.verification_document_issue_or_expiry_date_missingDocument is missing an expiration date. Provide a document with an expiration date.verification_document_manipulatedDocument seems to be altered. This could be because it’s fraudulent.verification_document_missing_backThe back of the document is missing. Provide both sides of the document for verification.verification_document_missing_frontThe front of the document is missing. Provide both sides of the document for verification.verification_document_name_mismatchThe name on the account does not match the name on the document. Update the account to match the document and upload it again.verification_document_name_missingThe company name was missing on the document. Upload a document that includes the company name.verification_document_nationality_mismatchThe nationality on the document did not match the person’s stated nationality. Update the person’s stated nationality, or upload a document that matches it.verification_document_not_readableDocument isn’t readable. This could be because it’s blurry or dark, or because the document was obstructed.verification_document_not_signedDocument doesn’t seem to be signed. Provide a signed document.verification_document_not_uploadedDocument didn’t upload because of a problem with the file.verification_document_photo_mismatchID photo on the document doesn’t match the selfie provided by this account.verification_document_too_largeDocument file is too large. Upload one that’s 10MB or less.verification_document_type_not_supportedThe provided document type is not accepted. Ensure that the document follows the guidelines for document uploads.verification_extraneous_directorsExtraneous directors have been added to the account. Update the account and upload a registration document with current directors.verification_failed_address_matchThe address on the account could not be verified. Correct any errors in the address field or upload a document that includes the address.verification_failed_authorizer_authorityThe account authorizer is not a registered authorized representative. Refer to this support article for more information.verification_failed_business_iec_numberThe Importer Exporter Code (IEC) number on your account could not be verified. Either correct any possible errors in the company name or IEC number. Refer to the support article for accepting international payments in India.verification_failed_document_matchThe document could not be verified. Upload a document that includes the company name, ID number, and address fields.verification_failed_id_number_matchID number on the document doesn’t match the ID number provided by this account.verification_failed_keyed_identityThe person’s keyed-in identity information could not be verified. Correct any errors or upload a document that matches the identity fields (e.g., name and date of birth) entered.verification_failed_keyed_matchThe keyed-in information on the account could not be verified. Correct any errors in the company name, ID number, or address fields. You can also upload a document that includes those fields.verification_failed_name_matchThe company name on the account could not be verified. Correct any errors in the company name field or upload a document that includes the company name.verification_failed_otherVerification failed for an unknown reason. Correct any errors and resubmit the required fields.verification_failed_representative_authorityThe authority of the account representative could not be verified. Please change the account representative to a person who is registered as an authorized representative. Please refer to this support article.verification_failed_residential_addressWe could not verify that the person resides at the provided address. The address must be a valid physical address where the individual resides and cannot be a P.O. Box.verification_failed_tax_id_matchThe tax ID on the account cannot be verified by the IRS. Either correct any possible errors in the company name or tax ID, or upload a document that contains those fields.verification_failed_tax_id_not_issuedThe tax ID on the account was not recognized by the IRS. Refer to the support article for newly-issued tax ID numbers.verification_legal_entity_structure_mismatchBusiness type or structure seems to be incorrect. Provide the correct business type and structure for this account.verification_missing_directorsWe identified that your business has directors that have not been added to the account. Please add missing directors to your account.verification_missing_executivesWe have identified executives that haven’t been added on the account. Add any missing executives to the account.verification_missing_ownersWe have identified owners that haven’t been added on the account. Add any missing owners to the account.verification_rejected_ownership_exemption_reasonThe ownership exemption reason was rejected.verification_requires_additional_memorandum_of_associationsWe have identified holding companies with significant percentage ownership. Upload a Memorandum of Association for each of the holding companies.verification_requires_additional_proof_of_registrationThe uploaded document contains holding companies with significant percentage ownership. Upload a proof of registration for each of the holding companies.verification_supportabilityWe can’t accept payments for this business under the Stripe Services Agreement without additional verification, as mentioned in the prohibited and restricted businesses list.
requirements.errors.reason(string) An informative message that indicates the error type and provides additional details about the error.requirements.errors.requirement(string) The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
requirements.past_due(array of strings, nullable) Fields that haven’t been resolved bycurrent_deadline. These fields need to be resolved to enable the external account.requirements.pending_verification(array of strings, nullable) Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move toeventually_due,currently_due,past_dueoralternatives. Fields might appear ineventually_due,currently_due,past_dueoralternativesand inpending_verificationif one verification fails but another is still pending.
routing_number(string, nullable) The routing transit number for the bank account.status(string) For bank accounts, possible values arenew,validated,verified,verification_failed,tokenized_account_number_deactivatedorerrored. A bank account that hasn’t had any activity or validation performed isnew. If Stripe can determine that the bank account exists, its status will bevalidated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will beverified. If the verification failed for any reason, such as microdeposit failure, the status will beverification_failed. If the status istokenized_account_number_deactivated, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we’ll set the status toerroredand will not continue to send scheduled payouts until the bank details are updated.For external accounts, possible values are
new,errored,verification_failed, andtokenized_account_number_deactivated. If a payout fails, the status is set toerroredand scheduled payouts are stopped until account details are updated. In the US and India, if we can’t verify the owner of the bank account, we’ll set the status toverification_failed. Other validations aren’t run against external accounts because they’re only used for payouts. This means the other statuses don’t apply.
The External Bank Account object ​
json
{
"id": "ba_1N9DrD2eZvKYlo2C58f4DaIa",
"object": "bank_account",
"account": "acct_1032D82eZvKYlo2C",
"account_holder_name": "Jane Austen",
"account_holder_type": "individual",
"account_type": null,
"available_payout_methods": [
"standard"
],
"bank_name": "STRIPE TEST BANK",
"country": "US",
"currency": "usd",
"fingerprint": "1JWtPxqbdX5Gamtz",
"last4": "6789",
"metadata": {},
"routing_number": "110000000",
"status": "new"
}