Retrieve Cash App Pay Grant | Welcome to Afterpay Documentation

curl -X POST https://global-api-sandbox.afterpay.com/v2/grants/retrieve \
     -H "User-Agent: User-Agent" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "customerId": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
  "grantId": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50"
}'

{
  "grant": {
    "id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
    "intent": "ON_FILE",
    "type": "CASHAPP",
    "details": {
      "status": "ACTIVE",
      "cashapp": {
        "customerId": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
        "cashtag": "$someCashTag"
      },
      "createdAt": "2024-07-08T22:42:46.039Z",
      "updatedAt": "2024-07-08T22:42:46.039Z",
      "expiresAt": "2034-07-08T22:42:46.039Z"
    }
  }
}

Retrieves a Cash App Pay customer grant by the ID of the customer that approved it and its own ID.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

This endpoint expects an object.

customerIdstringRequired1-128 characters

ID of the customer that approved the customer grant.

grantIdstringRequired1-256 characters

ID of the customer grant to retrieve.

Response

grantobject

Describes a grant provided by Cash App.

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Headers

Request

Response

Errors