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 valueschecking
Checkings account.
savings
Savings 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 valueschecking
Checkings account.
savings
Savings 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
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - routing_
numbernullable string The ACH routing number of the bank account.
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 deactivated with /deactivate, 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", "livemode": true}
Update a USBankAccount object. This is limited to supplying a previously empty routing_number field.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the USBankAccount object.
- fedwire_
routing_ numberstring The bank account’s fedwire routing number can be provided for update it was were empty previously.
- routing_
numberstring The bank account’s ACH routing number can be provided for update if it was empty previously.
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 valueschecking
Checkings account.
savings
Savings 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
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - routing_
numbernullable string The ACH routing number of the bank account.
Returned in cases where the bank account cannot be updated due to being archived.
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 deactivated with /deactivate, 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.
Returned in cases where the bank account cannot be updated due to requesting to update a field that already exists.
The resource wasn’t found.
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", "livemode": true}
Retrieve a USBankAccount object.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the USBankAccount object.
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 valueschecking
Checkings account.
savings
Savings 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
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - routing_
numbernullable string The ACH routing number of the bank account.
The resource wasn’t found.
{ "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", "livemode": true}
Archive a USBankAccount object. USBankAccount objects will not be automatically archived by Stripe. Archived USBankAccount objects cannot be used as outbound destinations and will not appear in the outbound destination list.
Learn more about calling API v2 endpoints.Parameters
- idstringRequired
The ID of the USBankAccount object.
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 valueschecking
Checkings account.
savings
Savings 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
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - routing_
numbernullable string The ACH routing number of the bank account.
Returned when the US Bank Account in question is controlled by the Stripe Dashboard, and cannot be archived.
The resource wasn’t found.
{ "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": true, "last4": "6789", "routing_number": "110000000", "livemode": true}
Use the GBBankAccounts API to create and manage GB bank account objects