Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Archive a UsBankAccount object v2

Core Resources
US Bank Accounts
Archive a UsBankAccount object

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 values
    checking

    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 value false if the object exists in test mode.

  • routing_numbernullable string

    The ACH routing number of the bank account.

Error Codes
400us_bank_account_cannot_be_archived

Returned when the US Bank Account in question is controlled by the Stripe Dashboard, and cannot be archived.

404not_found

The resource wasn’t found.

POST /v2/core/vault/us_bank_accounts/:id/archive
curl -X POST https://api.stripe.com/v2/core/vault/us_bank_accounts/usba_test_61OHSEF60mEpRiXpR16NqdMu76SQRZLd31xuji87MN5M/archive \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-05-28.preview"
Response
{
  "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
}