> 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:
  /api-key-schema-test:
    get:
      operationId: subpackageApiKeys_get-api-key-schema-test
      summary: Get ApiKey Schema Test
      description: >-
        Describes an API key used for authenticating requests to the Cash App
        Pay APIs.
      tags:
        - subpackage_apiKeys
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/apiKeys_get-api-key-schema-test_Response_200
tags:
  - name: subpackage_apiKeys
servers:
  - url: https://api.cash.app/management/v1
    description: Production
  - url: https://sandbox.api.cash.app/management/v1
    description: Sandbox
components:
  schemas:
    ScopesItems:
      type: string
      enum:
        - PAYMENTS_READ
        - PAYMENTS_WRITE
        - PAYOUTS_READ
        - PAYOUTS_WRITE
        - REFUNDS_READ
        - REFUNDS_WRITE
        - DISPUTES_READ
        - DISPUTES_WRITE
        - CUSTOMERS_READ
        - FEE_PLANS_READ
        - GRANTS_READ
        - GRANTS_WRITE
        - API_KEYS_READ
        - API_KEYS_WRITE
        - BRANDS_READ
        - BRANDS_WRITE
        - MERCHANTS_READ
        - MERCHANTS_WRITE
        - WEBHOOK_CONFIG_READ
        - WEBHOOK_CONFIG_WRITE
        - WEBHOOK_EVENTS_READ
      title: ScopesItems
    Scopes:
      type: array
      items:
        $ref: '#/components/schemas/ScopesItems'
      description: >-
        An array of permissions granted to the API key.


        Current values:


        - `API_KEYS_READ`: Permits listing API keys and retrieving individual
        keys.

        - `API_KEYS_WRITE`: Permits creating and deleting API keys.

        - `BRANDS_READ`: Permits listing brands and retrieving individual
        brands.

        - `BRANDS_WRITE`: Permits creating, upserting, and updating brands.

        - `CUSTOMERS_READ`: Permits listing customers and retrieving individual
        customers.

        - `DISPUTES_READ`: Permits listing disputes / dispute evidence and
        retrieving details about individual disputes / dispute evidence.

        - `DISPUTES_WRITE`: Permits uploading dispute evidence, accepting
        disputes, and challenging disputes.

        - `FEE_PLANS_READ`: Permits listing fee plans and retrieving individual
        fee plans.

        - `GRANTS_READ`: Permits listing grants for a customer and retrieving
        individual grants.

        - `GRANTS_WRITE`: Permits revoking a grant.

        - `MERCHANTS_READ`: Permits listing merchants and retrieving individual
        merchants.

        - `MERCHANTS_WRITE`: Permits creating, upserting, and updating
        merchants.

        - `PAYMENTS_READ`: Permits listing payments and retrieving individual
        payments.

        - `PAYMENTS_WRITE`: Permits taking payments, capturing payments, and
        voiding payments.

        - `PAYOUTS_READ`: Permits listing payouts and retrieving individual
        payouts.

        - `PAYOUTS_WRITE`: Permits creating payouts.

        - `REFUNDS_READ`: Permits listing refunds and retrieving individual
        refunds.

        - `REFUNDS_WRITE`: Permits issuing refunds, capturing refunds, and
        voiding refunds.

        - `WEBHOOK_CONFIG_READ`: Permits listing webhook delivery settings and
        retrieving individual configurations.

        - `WEBHOOK_CONFIG_WRITE`: Permits creating and updating webhook delivery
        settings.

        - `WEBHOOK_EVENTS_READ`: Permits listing webhook events and retrieving
        individual events.


        Min number of items: `1`
      title: Scopes
    ApiKey:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            Unique identifier for this API key issued by Cash App. This is the
            API key value that is passed in the `Authorization` header.
        created_at:
          type: string
          format: date-time
          description: >-
            When this API key was created, in [RFC
            3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC).
        expires_at:
          type: string
          format: date-time
          description: >-
            When this API key will be automatically deleted and become unusable,
            in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format
            (UTC).
        scopes:
          $ref: '#/components/schemas/Scopes'
        reference_id:
          type: string
          minLength: 1
          maxLength: 1024
          description: >-
            A user-defined identifier for this API key, typically used to
            associate the API key with a record in an external system.


            Min length: `1`

            Max length: `1024`
      required:
        - id
        - created_at
        - expires_at
        - scopes
      title: ApiKey
    apiKeys_get-api-key-schema-test_Response_200:
      type: object
      properties:
        api_key:
          $ref: '#/components/schemas/ApiKey'
      required:
        - api_key
      title: apiKeys_get-api-key-schema-test_Response_200

```

**`Example`**

```json Example
{
  "id": "KEY_2f6cd0d5cc26b34ac8785026b149797ecc0758be3dc3a857d405f2f62074ef30",
  "created_at": "2022-01-01T00:00:00Z",
  "expires_at": "2022-02-01T00:00:00Z",
  "scopes": [
    "PAYMENTS_READ"
  ],
  "reference_id": "string"
}
```