{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account Payment Intents API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Payment Intents", "type": "folder" }, "items": [ { "info": { "name": "GetPaymentIntents", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_intents", "params": [ { "name": "created", "value": "", "type": "query", "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options." }, { "name": "customer", "value": "", "type": "query", "description": "Only return PaymentIntents for the customer that this customer ID specifies." }, { "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." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Returns a list of PaymentIntents.

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

Creates a PaymentIntent object.

\n\n

After the PaymentIntent is created, attach a payment method and confirm\nto continue the payment. Learn more about the available payment flows\nwith the Payment Intents API.

\n\n

When you use confirm=true during creation, it’s equivalent to creating\nand confirming the PaymentIntent in the same call. You can use any parameters\navailable in the Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.\nDon’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\nconditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\nto an hour behind during outages. Search functionality is not available to merchants in India.

" }, { "info": { "name": "GetPaymentIntentsIntent", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/payment_intents/:intent", "params": [ { "name": "client_secret", "value": "", "type": "query", "description": "The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "intent", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of a PaymentIntent that has previously been created.

\n\n

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

\n\n

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

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

Updates properties on a PaymentIntent object without confirming.

\n\n

Depending on which properties you update, you might need to confirm the\nPaymentIntent again. For example, updating the payment_method\nalways requires you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties through\nthe confirm API instead.

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

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

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

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

\n\n

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_ca" }, { "info": { "name": "PostPaymentIntentsIntentCapture", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_intents/:intent/capture", "params": [ { "name": "intent", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

\n\n

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

\n\n

Learn more about separate authorization and capture.

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

Confirm that your customer intends to pay with current or provided\npayment method. Upon confirmation, the PaymentIntent will attempt to initiate\na payment.\nIf the selected payment method requires additional authentication steps, the\nPaymentIntent will transition to the requires_action status and\nsuggest additional actions via next_action. If payment fails,\nthe PaymentIntent transitions to the requires_payment_method status or the\ncanceled st" }, { "info": { "name": "PostPaymentIntentsIntentIncrementAuthorization", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_intents/:intent/increment_authorization", "params": [ { "name": "intent", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.

\n\n

Incremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the ne" }, { "info": { "name": "PostPaymentIntentsIntentVerifyMicrodeposits", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/payment_intents/:intent/verify_microdeposits", "params": [ { "name": "intent", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Verifies microdeposits on a PaymentIntent object.

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