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 PayoutMethod object v2

Money Management
Payout Methods
Archive a PayoutMethod object

Archive a PayoutMethod object. Archived objects cannot be used as payout methods and will not appear in the payout method list.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    ID of the payout method.

Returns

Response attributes

  • idstring

    ID of the PayoutMethod object.

  • objectstring, value is "v2.money_management.payout_method"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • available_payout_speedsarray of enums

    A set of available payout speeds for this payout method.

    Possible enum values
    instant

    Instant.

    standard

    Standard.

  • bank_accountnullable object

    The PayoutMethodBankAccount object details.

    • bank_account.archivedboolean

      Whether this PayoutMethodBankAccount object was archived. PayoutMethodBankAccount objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodBankAccount objects cannot be used as payout methods and will not appear in the payout method list.

    • bank_account.bank_namestring

      The name of the bank this bank account is in. This field is populated automatically by Stripe.

    • bank_account.countrystring

      The country code of the bank account.

    • bank_account.enabled_delivery_optionsarray of strings

      List of enabled flows for this bank account (wire or local).

    • bank_account.last4string

      The last 4 digits of the account number.

    • bank_account.routing_numbernullable string

      The routing number of the bank account, if present.

    • bank_account.supported_currenciesarray of strings

      The list of currencies supported by this bank account.

  • cardnullable object

    The PayoutMethodCard object details.

    • card.archivedboolean

      Whether the PayoutMethodCard object was archived. PayoutMethodCard objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodCard objects cannot be used as payout methods and will not appear in the payout method list.

    • card.exp_monthstring

      The month the card expires.

    • card.exp_yearstring

      The year the card expires.

    • card.last4string

      The last 4 digits of the card number.

  • createdtimestamp

    Created timestamp.

  • latest_outbound_setup_intentnullable string

    ID of the underlying active OutboundSetupIntent object, if any.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • typeenum

    The type of payout method.

    Possible enum values
    bank_account

    Bank account.

    card

    Card.

  • usage_statusobject

    Indicates whether the payout method has met the necessary requirements for outbound money movement.

    • usage_status.paymentsenum

      Payments status - used when sending OutboundPayments (sending funds to recipients).

      Possible enum values
      eligible

      Resources that have met all the necessary requirements.

      invalid

      Resources that can’t ever support the specified flow (e.g credit cards for transfers).

      requires_action

      Resources that need to meet more requirements / need to do more actions in order to be made usable.

    • usage_status.transfersenum

      Transfers status - used when making an OutboundTransfer (sending funds to yourself).

      Possible enum values
      eligible

      Resources that have met all the necessary requirements.

      invalid

      Resources that can’t ever support the specified flow (e.g credit cards for transfers).

      requires_action

      Resources that need to meet more requirements / need to do more actions in order to be made usable.

Error Codes
400bank_account_cannot_be_archived

Returned when the PayoutMethodBankAccount object is controlled by the Stripe Dashboard, and cannot be archived.

400invalid_payout_method

Returned in cases where the ID provided doesn’t correspond to a valid payout method.

404not_found

The resource wasn’t found.

POST /v2/money_management/payout_methods/:id/archive
curl -X POST https://api.stripe.com/v2/money_management/payout_methods/usba_test_61S8MLMQAjFLoPjqt16QsOpAPpE97EJALhqt1U5mCNB2/archive \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-05-28.preview"
Response
{
  "id": "usba_test_61S8MLMQAjFLoPjqt16QsOpAPpE97EJALhqt1U5mCNB2",
  "object": "v2.money_management.payout_method",
  "available_payout_speeds": [
    "standard"
  ],
  "bank_account": {
    "archived": true,
    "bank_name": "Test Bank",
    "country": "US",
    "enabled_delivery_options": [
      "local"
    ],
    "last4": "6789",
    "routing_number": "110000000",
    "supported_currencies": [
      "usd"
    ]
  },
  "created": "2025-03-04T16:32:04.907Z",
  "latest_outbound_setup_intent": "osi_test_61S8MLMXLJbg85kWm16QsOpAPpE97EJALhqt1U5mCXrk",
  "type": "bank_account",
  "usage_status": {
    "payments": "eligible",
    "transfers": "eligible"
  },
  "livemode": true
}