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.
Returns
Response attributes
- dataarray of objects
The list of payout methods.
- next_
page_ urlnullable string The next page url.
- previous_
page_ urlnullable string The previous page url.
{ "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": "replace_me" }, "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": "replace_me" }, "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}
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 valuesinstant
Instant.
standard
Standard.
- bank_
accountnullable object The PayoutMethodBankAccount object details.
- cardnullable object
The PayoutMethodCard object details.
- 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 valuefalse
if the object exists in test mode. - typeenum
The type of payout method.
Possible enum valuesbank_
account Bank account.
card
Card.
- usage_
statusobject Indicates whether the payout method has met the necessary requirements for outbound money movement.
Returned when the PayoutMethodBankAccount object is controlled by the Stripe Dashboard, and cannot be archived.
Returned in cases where the ID provided doesn’t correspond to a valid payout method.
The resource wasn’t found.
{ "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" ], "bank_account_type": "replace_me" }, "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}
Unarchive an PayoutMethod object.
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 valuesinstant
Instant.
standard
Standard.
- bank_
accountnullable object The PayoutMethodBankAccount object details.
- cardnullable object
The PayoutMethodCard object details.
- 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 valuefalse
if the object exists in test mode. - typeenum
The type of payout method.
Possible enum valuesbank_
account Bank account.
card
Card.
- usage_
statusobject Indicates whether the payout method has met the necessary requirements for outbound money movement.
Returned when the PayoutMethodBankAccount object is controlled by the Stripe Dashboard, and cannot be unarchived.
Returned in cases where the ID provided doesn’t correspond to a valid payout method.
The resource wasn’t found.
{ "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}
This is a list of all public thin events we currently send for updates to PayoutMethod, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.
Event types
Attributes
- idstring
Unique identifier for the event.
- objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.
- contextnullable string
Authentication context needed to fetch the event or related object.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - reasonnullable object
Reason for the event.
- related_
objectnullable object Object containing the reference to API resource relevant to the event.
- typestring, value is "v2.money_management.payout_method.updated"
The type of the event.
Fetched attributes
- dataobject
Additional data about the event.
The PayoutMethodsBankAccountSpec object.