How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stripe Payment Intents API

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

Stripe Payment Intents API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Intent, Intents, and Payments. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 11 operations across 9 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 2023-10-16.

Requests are made against a single base URL, https://api.stripe.com/.

11 operations 9 paths 15 schemas 3 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Payment Intents API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 3 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Intents 11
GET
/v1/payment_intents
Returns a list of PaymentIntents.
GetPaymentIntents 6 params body → 200default
POST
/v1/payment_intents
Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents…
PostPaymentIntents body → 200default
GET
/v1/payment_intents/search
Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language . Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating con…
GetPaymentIntentsSearch 4 params body → 200default
GET
/v1/payment_intents/{intent}
Retrieves the details of a PaymentIntent that has previously been created. You can retrieve a PaymentIntent client-side using a publishable key when the clientsecret is in the query string. If you re…
GetPaymentIntentsIntent 3 params body → 200default
POST
/v1/payment_intents/{intent}
Updates properties on a PaymentIntent object without confirming. Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the paymentmethod a…
PostPaymentIntentsIntent 1 param body → 200default
POST
/v1/payment_intents/{intent}/apply_customer_balance
Manually reconcile the remaining amount for a customerbalance PaymentIntent.
PostPaymentIntentsIntentApplyCustomerBalance 1 param body → 200default
POST
/v1/payment_intents/{intent}/cancel
You can cancel a PaymentIntent object when it’s in one of these statuses: requirespaymentmethod , requirescapture , requiresconfirmation , requiresaction or, in rare cases , processing . After it’s c…
PostPaymentIntentsIntentCancel 1 param body → 200default
POST
/v1/payment_intents/{intent}/capture
Capture the funds of an existing uncaptured PaymentIntent when its status is requirescapture . Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. Learn…
PostPaymentIntentsIntentCapture 1 param body → 200default
POST
/v1/payment_intents/{intent}/confirm
Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires add…
PostPaymentIntentsIntentConfirm 1 param body → 200default
POST
/v1/payment_intents/{intent}/increment_authorization
Perform an incremental authorization on an eligible PaymentIntent . To be eligible, the PaymentIntent’s status must be requirescapture and incrementalauthorizationsupported must be true . Incremental…
PostPaymentIntentsIntentIncrementAuthorization 1 param body → 200default
POST
/v1/payment_intents/{intent}/verify_microdeposits
Verifies microdeposits on a PaymentIntent object.
PostPaymentIntentsIntentVerifyMicrodeposits 1 param body → 200default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are payment_intent (39 properties), PostPaymentIntentsRequest (31 properties), PostPaymentIntentsIntentRequest (20 properties), PostPaymentIntentsIntentConfirmRequest (17 properties). Each schema is shown below with its type and property counts.

PostPaymentIntentsIntentRequest
object
20 properties
SearchResult
object
6 properties 4 required
GetPaymentIntentsRequest
object
PaymentFlowsPaymentIntentList
object
4 properties 4 required
PostPaymentIntentsIntentConfirmRequest
object
17 properties
PostPaymentIntentsIntentCaptureRequest
object
8 properties
PostPaymentIntentsIntentCancelRequest
object
2 properties
PostPaymentIntentsIntentApplyCustomerBalanceRequest
object
3 properties
error
object
An error response from the Stripe API
1 property 1 required
PostPaymentIntentsIntentVerifyMicrodepositsRequest
object
4 properties
PostPaymentIntentsRequest
object
31 properties 2 required
PostPaymentIntentsIntentIncrementAuthorizationRequest
object
7 properties 1 required
GetPaymentIntentsIntentRequest
object
payment_intent
object
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each orde…
39 properties 10 required
GetPaymentIntentsSearchRequest
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-payment-intents-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Payment Intents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.