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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Stripe

Stripe Payments API

The Payments API from Stripe — 23 operation(s) for payments.

Provider Profile APIs.io OpenAPI GitHub

Stripe Payments 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 Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 33 operations across 23 paths, and defines 55 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/.

33 operations 23 paths 55 schemas 14 GET19 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
Contact
Stripe Dev Platform Team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Stripe Payments 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 33

Across 23 paths, the API surfaces 33 operations — 14 GET, 19 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 33
GET
/v1/customers/{customer}/payment_methods
Stripe Get Customers Customer Payment Methods
getCustomersCustomerPaymentMethods 6 params body → 200default
GET
/v1/customers/{customer}/payment_methods/{payment_method}
Stripe Get Customers Customer Payment Methods Payment Method
getCustomersCustomerPaymentMethodsPaymentMethod 3 params body → 200default
GET
/v1/payment_intents
Stripe Get Payment Intents
getPaymentIntents 6 params body → 200default
POST
/v1/payment_intents
Stripe Post Payment Intents
postPaymentIntents body → 200default
GET
/v1/payment_intents/search
Stripe Get Payment Intents Search
getPaymentIntentsSearch 4 params body → 200default
GET
/v1/payment_intents/{intent}
Stripe Get Payment Intents
getPaymentIntentsIntent 3 params body → 200default
POST
/v1/payment_intents/{intent}
Stripe Post Payment Intents
postPaymentIntentsIntent 1 param body → 200default
POST
/v1/payment_intents/{intent}/apply_customer_balance
Stripe Post Payment Intents Apply Customer Balance
postPaymentIntentsIntentApplyCustomerBalance 1 param body → 200default
POST
/v1/payment_intents/{intent}/cancel
Stripe Post Payment Intents Cancel
postPaymentIntentsIntentCancel 1 param body → 200default
POST
/v1/payment_intents/{intent}/capture
Stripe Post Payment Intents Capture
postPaymentIntentsIntentCapture 1 param body → 200default
POST
/v1/payment_intents/{intent}/confirm
Stripe Post Payment Intents Confirm
postPaymentIntentsIntentConfirm 1 param body → 200default
POST
/v1/payment_intents/{intent}/increment_authorization
Stripe Post Payment Intents Increment Authorization
postPaymentIntentsIntentIncrementAuthorization 1 param body → 200default
POST
/v1/payment_intents/{intent}/verify_microdeposits
Stripe Post Payment Intents Verify Microdeposits
postPaymentIntentsIntentVerifyMicrodeposits 1 param body → 200default
GET
/v1/payment_links
Stripe Get Payment Links
getPaymentLinks 5 params body → 200default
POST
/v1/payment_links
Stripe Post Payment Links
postPaymentLinks body → 200default
GET
/v1/payment_links/{payment_link}
Stripe Get Payment Links
getPaymentLinksPaymentLink 2 params body → 200default
POST
/v1/payment_links/{payment_link}
Stripe Post Payment Links
postPaymentLinksPaymentLink 1 param body → 200default
GET
/v1/payment_links/{payment_link}/line_items
Stripe Get Payment Links Line Items
getPaymentLinksPaymentLinkLineItems 5 params body → 200default
GET
/v1/payment_method_configurations
Stripe Get Payment Method Configurations
getPaymentMethodConfigurations 2 params body → 200default
POST
/v1/payment_method_configurations
Stripe Post Payment Method Configurations
postPaymentMethodConfigurations body → 200default
GET
/v1/payment_method_configurations/{configuration}
Stripe Get Payment Method Configurations
getPaymentMethodConfigurationsConfiguration 2 params body → 200default
POST
/v1/payment_method_configurations/{configuration}
Stripe Post Payment Method Configurations
postPaymentMethodConfigurationsConfiguration 1 param body → 200default
GET
/v1/payment_method_domains
Stripe Get Payment Method Domains
getPaymentMethodDomains 6 params body → 200default
POST
/v1/payment_method_domains
Stripe Post Payment Method Domains
postPaymentMethodDomains body → 200default
GET
/v1/payment_method_domains/{payment_method_domain}
Stripe Get Payment Method Domains
getPaymentMethodDomainsPaymentMethodDomain 2 params body → 200default
POST
/v1/payment_method_domains/{payment_method_domain}
Stripe Post Payment Method Domains
postPaymentMethodDomainsPaymentMethodDomain 1 param body → 200default
POST
/v1/payment_method_domains/{payment_method_domain}/validate
Stripe Post Payment Method Domains Validate
postPaymentMethodDomainsPaymentMethodDomainValidate 1 param body → 200default
GET
/v1/payment_methods
Stripe Get Payment Methods
getPaymentMethods 6 params body → 200default
POST
/v1/payment_methods
Stripe Post Payment Methods
postPaymentMethods body → 200default
GET
/v1/payment_methods/{payment_method}
Stripe Get Payment Methods
getPaymentMethodsPaymentMethod 2 params body → 200default
POST
/v1/payment_methods/{payment_method}
Stripe Post Payment Methods
postPaymentMethodsPaymentMethod 1 param body → 200default
POST
/v1/payment_methods/{payment_method}/attach
Stripe Post Payment Methods Attach
postPaymentMethodsPaymentMethodAttach 1 param body → 200default
POST
/v1/payment_methods/{payment_method}/detach
Stripe Post Payment Methods Detach
postPaymentMethodsPaymentMethodDetach 1 param body → 200default

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are subscription (43 properties), payment_method (43 properties), payment_method_configuration (41 properties), PostPaymentMethodsRequest (40 properties). Each schema is shown below with its type and property counts.

customer
object
This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. Related guide: [Sav…
28 properties 4 required
SearchResult
object
6 properties 4 required
GetPaymentMethodConfigurationsRequest
object
payment_method
object
PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) t…
43 properties 6 required
GetPaymentLinksPaymentLinkLineItemsRequest
object
PostPaymentMethodsPaymentMethodDetachRequest
object
1 property
subscription
object
Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creati…
43 properties 16 required
GetPaymentIntentsIntentRequest
object
PostPaymentMethodsPaymentMethodAttachRequest
object
2 properties 1 required
PostPaymentIntentsIntentCaptureRequest
object
8 properties
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
deleted_customer
object
3 properties 3 required
PostPaymentIntentsIntentIncrementAuthorizationRequest
object
7 properties 1 required
card
object
You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer t…
28 properties 7 required
GetPaymentMethodsRequest
object
PostPaymentLinksPaymentLinkRequest
object
19 properties
PostPaymentMethodDomainsPaymentMethodDomainValidateRequest
object
1 property
tax_id
object
You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. Customer and account tax IDs get displayed on related in…
9 properties 6 required
PostPaymentIntentsIntentApplyCustomerBalanceRequest
object
3 properties
CustomerPaymentMethodResourceList
object
4 properties 4 required
PostPaymentIntentsRequest
object
31 properties 2 required
GetCustomersCustomerPaymentMethodsRequest
object
GetPaymentMethodDomainsPaymentMethodDomainRequest
object
PaymentMethodDomainResourcePaymentMethodDomainList
object
4 properties 4 required
payment_method_configuration
object
PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have…
41 properties 6 required
PaymentLinksResourceListLineItems
object
4 properties 4 required
GetCustomersCustomerPaymentMethodsPaymentMethodRequest
object
GetPaymentMethodDomainsRequest
object
PaymentFlowsPaymentMethodList
object
4 properties 4 required
PostPaymentLinksRequest
object
28 properties 1 required
error
object
An error response from the Stripe API
1 property 1 required
GetPaymentLinksPaymentLinkRequest
object
PaymentMethodConfigResourcePaymentMethodConfigurationsList
object
4 properties 4 required
PostPaymentMethodConfigurationsRequest
object
37 properties
bank_account
object
These bank accounts are payment methods on Customer objects. On the other hand [External Accounts](https://stripe.com/docs/apiexternalaccounts) are transfer de…
19 properties 6 required
PostPaymentIntentsIntentVerifyMicrodepositsRequest
object
4 properties
PostPaymentIntentsIntentCancelRequest
object
2 properties
PostPaymentMethodConfigurationsConfigurationRequest
object
37 properties
GetPaymentMethodsPaymentMethodRequest
object
GetPaymentIntentsSearchRequest
object
PostPaymentIntentsIntentRequest
object
20 properties
PostPaymentMethodDomainsPaymentMethodDomainRequest
object
2 properties
PaymentLinksResourcePaymentLinkList
object
4 properties 4 required
GetPaymentLinksRequest
object
payment_link
object
A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. When a customer…
33 properties 19 required
PaymentFlowsPaymentIntentList
object
4 properties 4 required
GetPaymentMethodConfigurationsConfigurationRequest
object
PostPaymentMethodsPaymentMethodRequest
object
6 properties
GetPaymentIntentsRequest
object
PostPaymentIntentsIntentConfirmRequest
object
17 properties
PostPaymentMethodDomainsRequest
object
3 properties 1 required
PostPaymentMethodsRequest
object
40 properties
discount
object
A discount represents the actual application of a [coupon](https://stripe.com/docs/apicoupons) or [promotion code](https://stripe.com/docs/apipromotioncodes).…
11 properties 4 required
cash_balance
object
A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment…
5 properties 4 required
payment_method_domain
object
A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where ce…
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-payments-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
AE Profile APIs.io
Stripe Balance API
AE Profile APIs.io
Stripe Billing API
AE Profile APIs.io
Stripe Charges API
AE Profile APIs.io
Stripe Checkout API
AE Profile APIs.io
Stripe Climate API
AE Profile APIs.io
Stripe Country API
AE Profile APIs.io
Stripe Coupons API
AE Profile APIs.io
Stripe Credit Notes API
AE Profile APIs.io
Stripe Customers API
AE Profile APIs.io
Stripe Disputes API
AE Profile APIs.io
Stripe Ephemeral Keys API
AE Profile APIs.io
#Payments
← Back to S APIs
API Details
ID
stripe:stripe-payments-api
Server
https://api.stripe.com/
Provider
Stripe
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=stripe-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/stripe-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Stripe Payments 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.