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

Afterpay Global API exposing merchant configuration and limits (such as minimum and maximum order amounts) for the Afterpay/Cash App Pay integration.

Afterpay Configuration 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 Configuration 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 9 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 9 schemas 2 GET

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 Configuration 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 — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Operations 2
GET
/v2/configuration
Get Configuration
get-configuration 4 params → 200401
GET
/v2/configuration/mappings
Get Configuration Mappings
get-configuration-mappings 3 params → 200401403

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Merchant-limit (5 properties), Get-configuration-mappingsRequestUnauthorizedError (4 properties), Get-configurationRequestUnauthorizedError (4 properties), Get-configuration-mappingsRequestForbiddenError (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
MerchantLimitConsumerLending
object
Returned only when include=consumerlending is requested. Indicates whether consumer lending is enabled for the merchant's online channel and, when enabled, the…
3 properties
MerchantLimitPayByInstallment
object
Returned only when include=paybyinstallment is requested and pay by installment is configured for the merchant. Contains the eligible order amount range for pa…
2 properties
Merchant-limit
object
5 properties
Get-configurationRequestUnauthorizedError
object
4 properties
ConfigurationMappings
object
2 properties 2 required
Get-configuration-mappingsRequestUnauthorizedError
object
4 properties
Get-configuration-mappingsRequestForbiddenError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cash-app-configuration-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 Orders 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)