> 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`) ```yaml openapi: 3.1.0 info: title: API version: 1.0.0 paths: /action-schema-test: get: operationId: subpackageSchemas_get-action-schema-test summary: Get Action Schema Test description: Describes the 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-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: Currency: type: string enum: - USD description: >- Indicates the country associated with an entity. Values are from the [ISO-4217 Alpha-3](https://www.iso.org/iso-4217-currency-codes.html) specification. Current values: - `USD`: United States Dollar title: Currency OneTimePaymentActionType: type: string enum: - ONE_TIME_PAYMENT description: The type of the action (`ONE_TIME_PAYMENT`). title: OneTimePaymentActionType OnFilePaymentActionType: type: string enum: - ON_FILE_PAYMENT default: ON_FILE_PAYMENT description: The type of the action (`ON_FILE_PAYMENT`). title: OnFilePaymentActionType OnFileDepositActionType: type: string enum: - ON_FILE_DEPOSIT description: The type of the action (`ON_FILE_DEPOSIT`). title: OnFileDepositActionType OnFilePayoutActionType: type: string enum: - ON_FILE_PAYOUT description: The type of the action (`ON_FILE_PAYOUT`). title: OnFilePayoutActionType LinkAccountActionType: type: string enum: - LINK_ACCOUNT description: The type of the action (`LINK_ACCOUNT`). title: LinkAccountActionType CheckingBalanceActionType: type: string enum: - CHECKING_BALANCE description: The type of the action (`CHECKING_BALANCE`). title: CheckingBalanceActionType Action: oneOf: - type: object properties: type: $ref: '#/components/schemas/OneTimePaymentActionType' description: The type of the action (`ONE_TIME_PAYMENT`). amount: type: integer minimum: 1 description: >- Amount to charge the customer, in the lowest unit of the associated currency. Min value: `1` currency: $ref: '#/components/schemas/Currency' scope_id: type: string minLength: 1 maxLength: 128 description: >- ID of the client, brand, or merchant that will charge the customer. 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. If a merchant ID is passed, the grant from this action can be used to create a payment for the merchant with a matching ID. Min length: `1` Max length: `128` required: - type - scope_id description: >- Describes an intent for a client to charge a customer a given amount. Note the following restrictions when using this action: - If no amount is provided to the action, the payment charged may be **any** amount. - If `amount` is provided, `currency` must be provided too (and vice versa). - type: object properties: type: $ref: '#/components/schemas/OnFilePaymentActionType' description: The type of the action (`ON_FILE_PAYMENT`). 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` account_reference_id: type: string minLength: 1 maxLength: 128 description: >- Identifier of the account or customer associated to the on file action. required: - type - scope_id 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." - type: object properties: type: $ref: '#/components/schemas/OnFileDepositActionType' description: The type of the action (`ON_FILE_DEPOSIT`). scope_id: type: string minLength: 1 maxLength: 128 description: >- ID of the client or brand that indicates the set of merchants that will deposit to customers. If a client ID is passed, the grant from this action can be used to create a deposit for any merchant owned by the client. If a brand ID is passed, the grant from this action can be used to create a deposit for any merchant that has a matching brand ID. Min length: `1` Max length: `128` account_reference_id: type: string description: >- Identifier of the account or customer associated to the on file action. required: - type - scope_id - account_reference_id description: >- Describes an intent for a client to deposit funds into the Cash App account balances in perpetuity until the Cash App account revokes the grant. - type: object properties: type: $ref: '#/components/schemas/OnFilePayoutActionType' description: The type of the action (`ON_FILE_PAYOUT`). scope_id: type: string minLength: 1 maxLength: 128 description: >- ID of the client or brand that indicates the set of merchants that will payout to customers. If a client ID is passed, the grant from this action can be used to create a payout for any merchant owned by the client. If a brand ID is passed, the grant from this action can be used to create a payout for any merchant that has a matching brand ID. Merchant IDs may *not* be passed. Min length: `1` Max length: `128` account_reference_id: type: string description: >- Identifier of the account or customer associated to the on file action. required: - type - scope_id description: >- Describes an intent for a client to payout funds from the Cash App account balances in perpetuity until the Cash App account revokes the grant. - type: object properties: type: $ref: '#/components/schemas/LinkAccountActionType' description: The type of the action (`LINK_ACCOUNT`). required: - type description: "Describes an\_intent for a client to manage a customer's merchant profiles in Cash App." - 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. discriminator: propertyName: type description: >- Represents what the client intends to do to a customer if given authorization. title: Action schemas_get-action-schema-test_Response_200: type: object properties: action: $ref: '#/components/schemas/Action' required: - action title: schemas_get-action-schema-test_Response_200 ``` **`Example`** ```json Example { "amount": 2500, "currency": "USD", "scope_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x", "type": "ONE_TIME_PAYMENT" } ```