Cash App Pay Customer Request API
REST API used to get permission from customers to perform actions on their accounts (such as collecting a payment), producing the grants consumed by the Network API. Wrapped by the Pay Kit JavaScript SDK.
Cash App Pay Customer Request API is one of 12 APIs that Cash App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments and Authorization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 3 operations across 2 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.cash.app/customer-request/v1, https://sandbox.api.cash.app/customer-request/v1.
3 operations
2 paths
39 schemas
1 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
requests 3
POST
/requests
Create request
GET
/requests/{request_id}
Retrieve request
PATCH
/requests/{request_id}
Update request
Schemas 39
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Request (16 properties), Grant (10 properties), RequestsPostRequestBodyContentApplicationJsonSchemaRequest (6 properties), RequestAuthFlowTriggers (5 properties). Each schema is shown below with its type and property counts.
IdempotencyKey
string
A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. Learn more about [idempotency](../docs/api/tec…
Currency
string
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. Curren…
OneTimePaymentActionType
string
The type of the action (ONETIMEPAYMENT).
OneTimePaymentAction
object
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…
4 properties
2 required
OnFilePaymentActionType
string
The type of the action (ONFILEPAYMENT).
OnFilePaymentAction
object
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.
3 properties
2 required
OnFileDepositActionType
string
The type of the action (ONFILEDEPOSIT).
OnFileDepositAction
object
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.
3 properties
3 required
OnFilePayoutActionType
string
The type of the action (ONFILEPAYOUT).
OnFilePayoutAction
object
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.
3 properties
2 required
LinkAccountActionType
string
The type of the action (LINKACCOUNT).
LinkAccountAction
object
Describes an intent for a client to manage a customer's merchant profiles in Cash App.
1 property
1 required
CheckingBalanceActionType
string
The type of the action (CHECKINGBALANCE).
CheckingBalanceAction
object
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.
2 properties
2 required
Action
Represents what the client intends to do to a customer if given authorization.
RequestsPostRequestBodyContentApplicationJsonSchemaRequestChannel
string
How the customer is expected to interact with the request. - INPERSON: The customer presents or scans a QR code at a physical location to approve the request.…
Metadata
object
Freeform key-value pairs of arbitrary data associated with this resource. Keys and values must be passed as strings and not contain any personally identifiable…
CustomerMetadata
object
Metadata to associate with the customer that approves this request.
1 property
RequestsPostRequestBodyContentApplicationJsonSchemaRequest
object
Details about the request to create.
6 properties
2 required
RequestStatus
string
Indicates if the state is approved, declined, or pending. Approved requests have grants, while pending and declined grants do not. Current values: - PENDING: T…
RequestAuthFlowTriggers
object
While the request is PENDING, contains different methods that can be used to start the authorization flow in the Cash App mobile application. Its contents refr…
5 properties
4 required
RequestOriginType
string
The method used to create the customer request. - DIRECT - the client or SDKs created this customer request by calling the "CreateCustomerRequest" endpoint - R…
RequestOrigin
object
Metadata describing how the customer request was created.
2 properties
1 required
Channel
string
How the customer is expected to interact with the request. - INPERSON: The customer presents or scans a QR code at a physical location to approve the request.…
GrantStatus
string
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 n…
GrantType
string
Describes whether this grant can be only be used once (ONETIME) or repeatedly (EXTENDED).
Grant
object
Describes a grant that can be used to perform actions specified in a customer request using the Network API.
10 properties
9 required
RequestRequesterProfile
object
Details about the brand or client that are requesting permission to perform the actions on the customer request.
2 properties
2 required
RequestCustomerProfile
object
If the customer request was approved, contains the identity of the Cash App customer that approved it.
2 properties
2 required
Request
object
Describes a request from a client to perform a given action on a customer's account.
16 properties
9 required
Requests_create-request_Response_201
object
1 property
1 required
Requests_retrieve-request_Response_200
object
1 property
1 required
ErrorCategory
string
The high-level reason the error occurred
Error
object
Represents an error encountered during a request to the API.
4 properties
2 required
ErrorResponse
object
1 property
1 required
RequestsRequestIdPatchRequestBodyContentApplicationJsonSchemaRequest
object
Details about the request to update
3 properties
Requests_update-request_Response_200
object
1 property
1 required
WebhooksCustomerRequestStateUpdatedPayloadContentApplicationJsonSchemaDataObject
object
A snapshot of the customer request data immediately after the customer request's state was updated.
1 property
1 required
WebhooksCustomerRequestStateUpdatedPayloadContentApplicationJsonSchemaData
object
Data about the customer request that was updated.
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cash App 11
Other APIs Cash App publishes across the network.
Cash App Pay Network API
Cash App Pay Management API
Afterpay Payments API
Afterpay Checkouts API
Afterpay Orders API
Afterpay Configuration API
Afterpay Disputes API
Afterpay Grants API
Add Cash App Pay to Your Site (Grants) API
Afterpay Service Status API
Afterpay Billing Agreements API (Deprecated)
#Payments#Authorization