{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account Payment Methods API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Payment Methods", "type": "folder" }, "items": [ { "info": { "name": "GetPaymentMethods", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_methods", "params": [ { "name": "customer", "value": "", "type": "query", "description": "The ID of the customer whose PaymentMethods will be retrieved." }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, { "name": "type", "value": "", "type": "query", "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

" }, { "info": { "name": "PostPaymentMethods", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_methods", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

\n\n

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

" }, { "info": { "name": "GetPaymentMethodsPaymentMethod", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_methods/:payment_method", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "payment_method", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

" }, { "info": { "name": "PostPaymentMethodsPaymentMethod", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_methods/:payment_method", "params": [ { "name": "payment_method", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

" }, { "info": { "name": "PostPaymentMethodsPaymentMethodAttach", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_methods/:payment_method/attach", "params": [ { "name": "payment_method", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Attaches a PaymentMethod object to a Customer.

\n\n

To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent\nor a PaymentIntent with setup_future_usage.\nThese approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach\nendpoint without fi" }, { "info": { "name": "PostPaymentMethodsPaymentMethodDetach", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_methods/:payment_method/detach", "params": [ { "name": "payment_method", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

" } ] } ], "bundled": true }