> This page is for Afterpay.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.cash.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.cash.app/_mcp/server.

### Schema (`response.body`)

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /grant-schema-test:
    get:
      operationId: subpackageSchemas_get-grant-schema-test
      summary: Get Grant Schema Test
      description: Describes a grant provided by Cash App.
      tags:
        - subpackage_schemas
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Schemas_get-grant-schema-test_Response_200
tags:
  - name: subpackage_schemas
servers:
  - url: https://global-api-sandbox.afterpay.com
    description: Sandbox
  - url: https://global-api.afterpay.com
    description: Production
components:
  schemas:
    CashGrantIntent:
      type: string
      enum:
        - ON_FILE
        - ONE_TIME
      description: Either ON_FILE or ONE_TIME
      title: CashGrantIntent
    CashGrantType:
      type: string
      enum:
        - CASHAPP
      description: CASHAPP for all Cash App Pay transactions
      title: CashGrantType
    CashGrantDetailsStatus:
      type: string
      enum:
        - ACTIVE
        - EXPIRED
        - CONSUMED
        - REVOKED
      description: >
        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 no longer be used to perform the action due to the
        current time being past the "expires_at" time.


        If `CONSUMED`, it was already redeemed to perform the action and cannot
        be used again.


        If `REVOKED`, the customer or merchant explicitly unauthorized the
        grant, preventing it from being used to perform the action.
      title: CashGrantDetailsStatus
    CashGrantDetailsCashapp:
      type: object
      properties:
        customerId:
          type: string
          minLength: 1
          maxLength: 128
        cashtag:
          type: string
          description: >-
            A publicly-accessible, unique identifier (username) for individuals
            and businesses using Cash App.
      required:
        - customerId
        - cashtag
      title: CashGrantDetailsCashapp
    CashGrantDetails:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/CashGrantDetailsStatus'
          description: >
            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 no longer be used to perform the action due to
            the current time being past the "expires_at" time.


            If `CONSUMED`, it was already redeemed to perform the action and
            cannot be used again.


            If `REVOKED`, the customer or merchant explicitly unauthorized the
            grant, preventing it from being used to perform the action.
        cashapp:
          $ref: '#/components/schemas/CashGrantDetailsCashapp'
        createdAt:
          type: string
          description: >-
            When this grant was created, in [RFC
            3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).
        updatedAt:
          type: string
          description: >-
            When this grant was last updated, in [RFC
            3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).
        expiresAt:
          type: string
          description: >
            If present, indicates when the grant's status will become EXPIRED,
            preventing a client from using it to create payments or refunds.


            The timestamp is in the [RFC
            3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).
      required:
        - status
        - cashapp
        - createdAt
        - updatedAt
        - expiresAt
      title: CashGrantDetails
    CashGrant:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 256
          description: Unique identifier for this grant issued by Cash App.
        intent:
          $ref: '#/components/schemas/CashGrantIntent'
          description: Either ON_FILE or ONE_TIME
        type:
          $ref: '#/components/schemas/CashGrantType'
          description: CASHAPP for all Cash App Pay transactions
        details:
          $ref: '#/components/schemas/CashGrantDetails'
      required:
        - id
        - intent
        - type
        - details
      description: Describes a grant provided by Cash App.
      title: CashGrant
    Schemas_get-grant-schema-test_Response_200:
      type: object
      properties:
        grant:
          $ref: '#/components/schemas/CashGrant'
      required:
        - grant
      title: Schemas_get-grant-schema-test_Response_200

```

**`Example`**

```json Example
{
  "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"
  }
}
```