Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZeroSettle Checkout API

Create checkout sessions and payment intents for web purchases

ZeroSettle Checkout API is one of 12 APIs that ZeroSettle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Checkout. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.zerosettle.io/v1.

3 operations 3 paths 3 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.zerosettle.io/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ZeroSettle Checkout API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-ZeroSettle-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Your publishable API key. Use zspktest for sandbox or zspklive for production.

Paths & Operations 3

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

Checkout 3

Create checkout sessions and payment intents for web purchases

POST
/iap/payment-intents
Create Payment Intent
createPaymentIntent body → 200400401502
POST
/iap/payment-intents/batch
Create Payment Intent Batch
createPaymentIntentBatch body → 200400401502
POST
/iap/checkout-sessions
Create Checkout Session
createCheckoutSession body → 200400401502

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PaymentIntentResponse (13 properties), CheckoutSessionResponse (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

CheckoutSessionResponse
object
Response from creating a checkout session.
4 properties
PaymentIntentResponse
object
Response from creating a payment intent.
13 properties
Error
object
Error response.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zerosettle-checkout-api-openapi.yml Raw ↑

Other APIs ZeroSettle publishes across the network.

ZeroSettle Cancel Flow API
ZeroSettle Entitlements API
ZeroSettle Events API
ZeroSettle Migration API
ZeroSettle Products API
ZeroSettle Restore API
ZeroSettle StoreKit API
ZeroSettle Subscriptions API
ZeroSettle Transactions API
ZeroSettle Upgrade Offers API
ZeroSettle User Offer API