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

Afterpay Global API for retrieving and managing the grants that authorize Afterpay payment operations on a customer's behalf.

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

This API exposes 6 operations across 6 paths, and defines 20 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.

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

Paths & Operations 6

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

Operations 6
POST
/v2/grants/approvals
Create Grant Approval
start-grant-approval 2 params body → 200401403415422
POST
/v2/grants
Create Grant
create-grant 2 params body → 201403412415
GET
/v2/grants/{grantId}
Retrieve Grant
get-grant 2 params → 200403404
POST
/v2/grants/{grantId}/revoke
Revoke Grant
revoke-grant 2 params → 200403404
POST
/v2/grants/alias
Create Grant Alias
alias-grant 2 params body → 200403415
POST
/v2/grants/start
Start Grant Link Flow
start-billing-agreement-link 2 params body → 201404412429

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Grant (10 properties), GrantApprovalRequestMerchant (4 properties), Consumer (4 properties), OnFileGrantStatusUpdated (4 properties). Each schema is shown below with its type and property counts.

GrantApprovalTypeType
string
Grant Type for approval.
GrantApprovalType
object
Details about the grant to be created.
2 properties 1 required
GrantApprovalRequestMerchant
object
4 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
GrantApprovalRequest
object
3 properties 2 required
GrantApprovalResponse
object
3 properties 3 required
CreateGrantRequest
object
3 properties 2 required
GrantType
string
Type of grant
GrantStatus
string
Current status of the grant
Grant
object
10 properties 4 required
GrantResponse
object
1 property 1 required
GrantAliasRequest
object
2 properties 1 required
GrantAliasResponse
object
2 properties 2 required
GrantStartRequest
object
2 properties 2 required
GrantStartResponseDeliveryType
string
How the verification code was delivered to the consumer
GrantStartResponse
object
4 properties 4 required
OnFileGrantStatusUpdatedDataType
string
OnFileGrantStatusUpdatedDataObject
object
1 property
OnFileGrantStatusUpdatedData
object
3 properties 3 required
OnFileGrantStatusUpdated
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cash-app-grants-afterpay-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 Configuration API
Afterpay Disputes API
Add Cash App Pay to Your Site (Grants) API
Afterpay Service Status API
Afterpay Billing Agreements API (Deprecated)