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

Afterpay Checkouts API

Afterpay Global API for creating and retrieving checkout sessions that begin an Afterpay buy-now-pay-later order flow.

Afterpay Checkouts API is one of 12 APIs that Cash App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://global-api-sandbox.afterpay.com, https://global-api.afterpay.com.

2 operations 2 paths 13 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://global-api.afterpay.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Afterpay Checkouts API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (sec0).

Paths & Operations 2

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

Operations 2
POST
/v2/checkouts
Create Checkout
create-checkout-1 3 params body → 201400422
GET
/v2/checkouts/{token}
Get Checkout
get-checkout 4 params → 200404412

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are get-checkout_Response_200 (16 properties), Checkout-Request (13 properties), Contact (9 properties), Item (9 properties). Each schema is shown below with its type and property counts.

MoneyCurrency
string
Money
object
Object containing amount and currency
2 properties 2 required
Consumer
object
The consumer data model is used for gathering essential user information. It captures details such as the individual's first name, represented by givenNames, a…
4 properties 1 required
ContactCountryCode
string
Contact
object
This data model is used for storing an individual's contact information. Mandatory fields such as name, line1, area1, region, postcode, and countryCode help in…
9 properties 6 required
CheckoutRequestMerchant
object
4 properties 2 required
Item
object
This data model is used to store crucial product details. The price.amount field represents the unit price of the individual item. The quantity field shows the…
9 properties 3 required
ShippingCourierPriority
string
Shipping-Courier
object
Essential information for tracking a shipment. The shippedAt key represents the date and time when the item was shipped. This value follows the [ISO 8601 stand…
4 properties
Discount
object
Discount applied to an order
2 properties
Checkout-Request
object
Individual Checkout
13 properties 2 required
Checkout-Response
object
3 properties
get-checkout_Response_200
object
16 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cash-app-checkouts-openapi.json Raw ↑

Other APIs Cash App publishes across the network.

Cash App Pay Network API
Cash App Pay Customer Request API
Cash App Pay Management API
Afterpay Payments API
Afterpay Orders API
Afterpay Configuration API
Afterpay Disputes API
Afterpay Grants API
Add Cash App Pay to Your Site (Grants) API
Afterpay Service Status API
Afterpay Billing Agreements API (Deprecated)