> 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:
  /on-file-payment-action-schema-test:
    get:
      operationId: subpackageSchemas_get-on-file-payment-action-schema-test
      summary: Get OnFilePaymentAction Schema Test
      description: Describes an on-file payment 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-on-file-payment-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:
    OnFilePaymentActionType:
      type: string
      enum:
        - ON_FILE_PAYMENT
      default: ON_FILE_PAYMENT
      description: The type of the action (`ON_FILE_PAYMENT`).
      title: OnFilePaymentActionType
    OnFilePaymentAction:
      type: object
      properties:
        scope_id:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            ID of the client or brand that will charge customers.


            If a client ID is passed, the grant from this action can be used to
            create a payment for any merchant owned by the client.


            If a brand ID is passed, the grant from this action can be used to
            create a payment for any merchant that has a matching brand ID.


            Merchant IDs may *not* be passed.


            Min length: `1`

            Max length: `128`
        type:
          $ref: '#/components/schemas/OnFilePaymentActionType'
          description: The type of the action (`ON_FILE_PAYMENT`).
        account_reference_id:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            Identifier of the account or customer associated to the on file
            action.
      required:
        - scope_id
        - type
      description: "Describes an\_intent for a client to store a customer's account, allowing a client to create payments or issue refunds for it on a recurring basis."
      title: OnFilePaymentAction
    schemas_get-on-file-payment-action-schema-test_Response_200:
      type: object
      properties:
        on_file_payment_action:
          $ref: '#/components/schemas/OnFilePaymentAction'
      required:
        - on_file_payment_action
      title: schemas_get-on-file-payment-action-schema-test_Response_200

```

**`Example`**

```json Example
{
  "scope_id": "BRAND_8ereg0tug2yiik8vx24xpe5br",
  "type": "ON_FILE_PAYMENT",
  "account_reference_id": "string"
}
```