List all PayoutMethod objects v2

Money Management
Payout Methods
List all PayoutMethod objects

List objects that adhere to the PayoutMethod interface.

Learn more about calling API v2 endpoints.

Parameters

  • limitinteger

    The page size.

  • pagestring

    The requested page.

  • usage_statusobject

    Usage status filter.

    • usage_status.paymentsarray of enums

      List of payments status to filter by.

      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.transfersarray of enums

      List of transfers status to filter by.

      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.

Returns

Response attributes

  • dataarray of objects

    The list of payout methods.

    • data.idstring

      ID of the PayoutMethod object.

    • data.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.

    • data.available_payout_speedsarray of enums

      A set of available payout speeds for this payout method.

      Possible enum values
      instant

      Instant.

      standard

      Standard.

    • data.bank_accountnullable object

      The PayoutMethodBankAccount object details.

      • data.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.

      • data.bank_account.bank_account_typeenum

        The type of bank account (checking or savings).

        Possible enum values
        checking

        Checking account.

        savings

        Savings account.

      • data.bank_account.bank_namestring

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

      • data.bank_account.countrystring

        The country code of the bank account.

      • data.bank_account.enabled_delivery_optionsarray of strings

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

      • data.bank_account.last4string

        The last 4 digits of the account number.

      • data.bank_account.routing_numbernullable string

        The routing number of the bank account, if present.

      • data.bank_account.supported_currenciesarray of strings

        The list of currencies supported by this bank account.

    • data.cardnullable object

      The PayoutMethodCard object details.

      • data.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.

      • data.card.exp_monthstring

        The month the card expires.

      • data.card.exp_yearstring

        The year the card expires.

      • data.card.last4string

        The last 4 digits of the card number.

    • data.createdtimestamp

      Created timestamp.

    • data.latest_outbound_setup_intentnullable string

      ID of the underlying active OutboundSetupIntent object, if any.

    • data.livemodeboolean

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

    • data.typeenum

      The type of payout method.

      Possible enum values
      bank_account

      Bank account.

      card

      Card.

      crypto_wallet

      Crypto wallet.

    • data.usage_statusobject

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

      • data.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.

      • data.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.

  • next_page_urlnullable string

    The next page url.

  • previous_page_urlnullable string

    The previous page url.

GET /v2/money_management/payout_methods
curl https://api.stripe.com/v2/money_management/payout_methods \
-H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
-H "Stripe-Version: 2025-09-30.preview"
Response
{
"data": [
{
"id": "card_test_61SITa59fSaPfOGuU16QsOpAPpE97EJALhqt1U5mC1lg",
"object": "v2.money_management.payout_method",
"available_payout_speeds": [
"standard",
"instant"
],
"card": {
"archived": false,
"exp_month": "10",
"exp_year": "2028",
"last4": "5556"
},
"created": "2025-04-01T14:17:05.425Z",
"latest_outbound_setup_intent": null,
"type": "card",
"usage_status": {
"payments": "eligible",
"transfers": "eligible"
},
"livemode": true
},
{
"id": "gbba_test_61SITWKOFwHCpdRSV16QsOpAPpE97EJALhqt1U5mCDyS",
"object": "v2.money_management.payout_method",
"available_payout_speeds": [
"standard"
],
"bank_account": {
"archived": false,
"bank_name": "Test Bank",
"country": "GB",
"enabled_delivery_options": [
"local"
],
"last4": "2345",
"routing_number": "108800",
"supported_currencies": [
"gbp"
],
"bank_account_type": "checking"
},
"created": "2025-04-01T14:13:12.295Z",
"latest_outbound_setup_intent": "osi_test_61SITWK7KhLsQIGAK16QsOpAPpE97EJALhqt1U5mC4kq",
"type": "bank_account",
"usage_status": {
"payments": "requires_action",
"transfers": "eligible"
},
"livemode": true
},
{
"id": "gbba_test_61Qz1meKFu38uCGVY16QsOpAPpE97EJALhqt1U5mCBVQ",
"object": "v2.money_management.payout_method",
"available_payout_speeds": [
"standard"
],
"bank_account": {
"archived": false,
"bank_name": "Test Bank",
"country": "GB",
"enabled_delivery_options": [
"local"
],
"last4": "2345",
"routing_number": "108800",
"supported_currencies": [
"gbp"
],
"bank_account_type": "checking"
},
"created": "2024-08-19T22:13:24.332Z",
"latest_outbound_setup_intent": null,
"type": "bank_account",
"usage_status": {
"payments": "eligible",
"transfers": "eligible"
},
"livemode": true
}
],
"next_page_url": null,
"previous_page_url": null
}