> This page is for Cash App Pay Partner API.

> 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:
  /checking-balance-action-schema-test:
    get:
      operationId: subpackageSchemas_get-checking-balance-action-schema-test
      summary: Get CheckingBalanceAction Schema Test
      description: Describes a checking balance action included in a customer request.
      tags:
        - subpackage_schemas
      parameters:
        - name: X-Region
          in: header
          description: >-
            The IATA airport code from the list of accepted regions that is
            closest to the area your server(s) is operating in.
          required: true
          schema:
            type: string
        - name: X-Signature
          in: header
          description: >-
            An HMAC signature generated using the secret value from the API key
            specified in the `Authorization` header. See [signing
            requests](https://developers.cash.app/docs/partner/technical-documentation/api-fundamentals/requests/signing-requests)
            for more information.
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/schemas_get-checking-balance-action-schema-test_Response_200
tags:
  - name: subpackage_schemas
servers:
  - url: https://api.cash.app/customer-request/v1
    description: Production
  - url: https://sandbox.api.cash.app/customer-request/v1
    description: Sandbox
components:
  schemas:
    CheckingBalanceActionType:
      type: string
      enum:
        - CHECKING_BALANCE
      description: The type of the action (`CHECKING_BALANCE`).
      title: CheckingBalanceActionType
    CheckingBalanceAction:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CheckingBalanceActionType'
          description: The type of the action (`CHECKING_BALANCE`).
        scope_id:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            ID of the client or brand requesting access to read the customer's
            balances.


            If a client ID is passed, the grant from this action can be used to
            read balances on behalf of the client.


            If a brand ID is passed, the grant from this action can be used to
            read balances on behalf of any merchant that has a matching brand
            ID.


            Merchant IDs may *not* be passed.


            Min length: `1`

            Max length: `128`
      required:
        - type
        - scope_id
      description: >-
        Describes an intent for a client to read a customer's Cash App checking
        balance until the customer revokes the grant.


        **Beta:** This action is in beta.
      title: CheckingBalanceAction
    schemas_get-checking-balance-action-schema-test_Response_200:
      type: object
      properties:
        checking_balance_action:
          $ref: '#/components/schemas/CheckingBalanceAction'
      required:
        - checking_balance_action
      title: schemas_get-checking-balance-action-schema-test_Response_200

```

**`Example`**

```json Example
{
  "type": "CHECKING_BALANCE",
  "scope_id": "BRAND_8ereg0tug2yiik8vx24xpe5br"
}
```