Create a USBankAccount object.
Learn more about calling API v2 endpoints.Parameters
- account_
numberstringRequired The account number of the bank account.
- bank_
account_ typeenum The type of the bank account (checking or savings).
Possible enum valuescheckingCheckings account.
savingsSavings account.
- fedwire_
routing_ numberstring The fedwire routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
- routing_
numberstring The ACH routing number of the bank account. Note that certain banks have the same ACH and wire routing number.
Returns
Response attributes
- idstring
The ID of the USBankAccount object.
- objectstring, value is "v2.core.vault.us_bank_account"
String representing the object’s type. Objects of the same type share the same value of the object field.
- archivedboolean
Whether this USBankAccount object was archived.
- bank_
account_ typeenum The type of bank account (checking or savings).
Possible enum valuescheckingCheckings account.
savingsSavings account.
- bank_
namestring The name of the bank this bank account belongs to. This field is populated automatically by Stripe based on the routing number.
- createdtimestamp
Creation time of the object.
- fedwire_
routing_ numbernullable string The fedwire routing number of the bank account.
- last4string
The last 4 digits of the account number.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - routing_
numbernullable string The ACH routing number of the bank account.
- verificationobject
The bank account verification details.
- verification.
microdeposit_ verification_ detailsnullable object The microdeposit verification details if the status is awaiting verification.
- verification.
microdeposit_verification_details. expirestimestamp Time when microdeposits will expire and have to be re-sent.
- verification.
microdeposit_verification_details. microdeposit_ typeenum Microdeposit type can be amounts or descriptor_type.
- verification.
microdeposit_verification_details. senttimestamp Time when microdeposits were sent.
- verification.
statusenum The bank account verification status.
Possible enum valuesawaiting_verification Verification of the bank account has been initiated and requires further action to be completed.
unverifiedThe bank account is unverified.
verification_failed Verification of the bank account has failed.
verifiedThe bank account is verified.
Returned in cases where the bank account cannot be used due to suspicious activity.
Returned in cases where the bank account provided is not valid (wrong format of account number or a routing number that does not correspond to a banking institution).
Returned when the number of USBankAccount objects on a given V2 Account has exceeded the limit of 10. USBankAccount objects may be archived with /archive, at which point they will not count against the limit. If you are not passing a V2 Account ID in the Stripe-Context header you may receive this error since you are creating all your USBankAccount objects in your own workspace.
Returned in cases where Stripe is unable to support this bank at this time.
An idempotent retry occurred with different request parameters.
{ "id": "usba_test_61OHSEF60mEpRiXpR16NqdMu76SQRZLd31xuji87MN5M", "object": "v2.core.vault.us_bank_account", "bank_account_type": "checking", "bank_name": "Test Bank", "created": "2023-05-15T16:29:15.738Z", "archived": false, "last4": "6789", "routing_number": "110000000", "verification": { "microdeposit_verification_details": null, "status": "unverified" }, "livemode": true}- Need help? Contact Support.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc