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 Setup Intents API

The Setup Intents API from Stripe — 6 operation(s) for setup intents.

Stripe Setup Intents API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

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

This API exposes 8 operations across 6 paths, and defines 12 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/.

8 operations 6 paths 12 schemas 3 GET5 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 Setup 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 8

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

Setup Intents 8
GET
/v1/setup_intents
Returns a list of SetupIntents.
GetSetupIntents 8 params body → 200default
POST
/v1/setup_intents
Creates a SetupIntent object. After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.
PostSetupIntents body → 200default
GET
/v1/setup_intents/{intent}
Retrieves the details of a SetupIntent that has previously been created. Client-side retrieval using a publishable key is allowed when the clientsecret is provided in the query string. When retrieved…
GetSetupIntentsIntent 3 params body → 200default
POST
/v1/setup_intents/{intent}
Updates a SetupIntent object.
PostSetupIntentsIntent 1 param body → 200default
POST
/v1/setup_intents/{intent}/cancel
You can cancel a SetupIntent object when it’s in one of these statuses: requirespaymentmethod , requiresconfirmation , or requiresaction . After you cancel it, setup is abandoned and any operations o…
PostSetupIntentsIntentCancel 1 param body → 200default
POST
/v1/setup_intents/{intent}/confirm
Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management…
PostSetupIntentsIntentConfirm 1 param body → 200default
POST
/v1/setup_intents/{intent}/verify_microdeposits
Verifies microdeposits on a SetupIntent object.
PostSetupIntentsIntentVerifyMicrodeposits 1 param body → 200default
GET
/v1/setup_attempts
List Setup Attempts
GetSetupAttempts 4 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are setup_intent (25 properties), PostSetupIntentsRequest (19 properties), setup_attempt (13 properties), PostSetupIntentsIntentRequest (11 properties). Each schema is shown below with its type and property counts.

error_2
object
1 property
PostSetupIntentsIntentVerifyMicrodepositsRequest
object
4 properties
GetSetupIntentsIntentRequest
object
PostSetupIntentsIntentRequest
object
11 properties
error
object
An error response from the Stripe API
1 property 1 required
PostSetupIntentsRequest
object
19 properties
GetSetupIntentsRequest
object
PostSetupIntentsIntentCancelRequest
object
2 properties
PaymentFlowsSetupIntentList
object
4 properties 4 required
setup_attempt
object
13 properties 8 required
setup_intent
object
A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupInt…
25 properties 7 required
PostSetupIntentsIntentConfirmRequest
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-setup-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 Setup 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.