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 Orders API

Afterpay Global API for retrieving order details associated with an Afterpay buy-now-pay-later transaction.

Afterpay Orders 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 Orders and Afterpay. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 1 operation across 1 path, and defines 19 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.

1 operations 1 paths 19 schemas 1 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 Orders API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (sec0).

Paths & Operations 1

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

Operations 1
POST
/v2/orders
Create Order
create-grant 2 params body → 201415422

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are OrderRequest (15 properties), Contact (9 properties), Item (9 properties), Consumer (4 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
InitiationActor
string
The party who initiated the order
Initiation
object
1 property 1 required
SubscriptionType
string
SubscriptionInterval
string
Subscription
object
3 properties
Enrichments
object
2 properties 1 required
OrderRequestPaymentScheduleType
string
The payment schedule type for the order.
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
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
Discount
object
Discount applied to an order
2 properties
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
OrderRequest
object
15 properties 4 required
PaymentSchedule
object
Represents a scheduled payment installment
2 properties 2 required
CreateOrderResponse
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cash-app-orders-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 Checkouts 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)