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

Add Cash App Pay to Your Site (Grants) API

Afterpay Global API surface for retrieving Cash App Pay grants when adding Cash App Pay directly to a website through the Afterpay Global API.

Add Cash App Pay to Your Site (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 Cash App Pay. 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 2 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

Add Cash App Pay to Your Site (Grants) 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 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 2
POST
/v2/grants/retrieve
Retrieve Grant
retrieve-grant 3 params body → 200401403
POST
/v2/grants/revoke
Revoke Grant
revoke-grant 3 params body → 200401403

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CashGrantDetails (5 properties), Revoke-grantRequestUnauthorizedError (4 properties), Retrieve-grantRequestForbiddenError (4 properties), Retrieve-grantRequestUnauthorizedError (4 properties). Each schema is shown below with its type and property counts.

RetrieveGrantRequest
object
2 properties 2 required
CashGrantIntent
string
Either ONFILE or ONETIME
CashGrantType
string
CASHAPP for all Cash App Pay transactions
CashGrantDetailsStatus
string
Describes whether or not this grant can be used to perform the action associated with it. If ACTIVE, it can be used to perform the action. If EXPIRED, it may n…
CashGrantDetailsCashapp
object
2 properties 2 required
CashGrantDetails
object
5 properties 5 required
CashGrant
object
Describes a grant provided by Cash App.
4 properties 4 required
retrieve-grant_Response_200
object
1 property 1 required
Retrieve-grantRequestUnauthorizedError
object
4 properties
Retrieve-grantRequestForbiddenError
object
4 properties
revoke-grant_Response_200
object
1 property 1 required
Revoke-grantRequestUnauthorizedError
object
4 properties
Revoke-grantRequestForbiddenError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cash-app-grants-cash-app-pay-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
Afterpay Grants API
Afterpay Service Status API
Afterpay Billing Agreements API (Deprecated)