How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cash App Requests API

The requests API from Cash App — 2 operation(s) for requests.

Cash App Requests API is one of 19 APIs that Cash App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Requests. 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 37 schemas. It is described by OpenAPI 3.2.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 37 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cash.app/network/v1
Resource Areas
1

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
create-request 2 params body → 201
GET
/requests/{request_id}
Retrieve request
retrieve-request 3 params → 200404
PATCH
/requests/{request_id}
Update request
update-request 3 params body → 200400404

Schemas 37

The contract defines 37 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.

RequestsRequestIdPatchRequestBodyContentApplicationJsonSchemaRequest
object
Details about the request to update
3 properties
RequestOrigin
object
Metadata describing how the customer request was created.
2 properties 1 required
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.…
RequestRequesterProfile
object
Details about the brand or client that are requesting permission to perform the actions on the customer request.
2 properties 2 required
Action
Represents what the client intends to do to a customer if given authorization.
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.…
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…
RequestsPostRequestBodyContentApplicationJsonSchemaRequest
object
Details about the request to create.
6 properties 2 required
OnFilePayoutActionType
string
The type of the action (ONFILEPAYOUT).
Error
object
Represents an error encountered during a request to the API.
4 properties 2 required
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…
GrantType
string
Describes whether this grant can be only be used once (ONETIME) or repeatedly (EXTENDED).
ErrorCategory
string
The high-level reason the error occurred
OneTimePaymentActionType
string
The type of the action (ONETIMEPAYMENT).
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…
OnFileDepositActionType
string
The type of the action (ONFILEDEPOSIT).
Requests_create-request_Response_201
object
1 property 1 required
CheckingBalanceActionType
string
The type of the action (CHECKINGBALANCE).
CustomerMetadata
object
Metadata to associate with the customer that approves this request.
1 property
Requests_retrieve-request_Response_200
object
1 property 1 required
ErrorResponse
object
1 property 1 required
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
LinkAccountActionType
string
The type of the action (LINKACCOUNT).
Request
object
Describes a request from a client to perform a given action on a customer's account.
16 properties 9 required
OnFilePaymentActionType
string
The type of the action (ONFILEPAYMENT).
RequestCustomerProfile
object
If the customer request was approved, contains the identity of the Cash App customer that approved it.
2 properties 2 required
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…
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
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
Requests_update-request_Response_200
object
1 property 1 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…
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…
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
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
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
LinkAccountAction
object
Describes an intent for a client to manage a customer's merchant profiles in Cash App.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cash-app-requests-api-openapi.yml Raw ↑

Other APIs Cash App publishes across the network.

Cash App Add Cash App Pay To Your Site API
Cash App API Keys API
Cash App Balances API
Cash App Billing Agreements (Deprecated) API
Cash App Brands API
Cash App Customer Request API
Cash App Customers API
Cash App App Default API
Cash App Disputes API
Cash App Fee Plans API
Cash App Grants Afterpay API
Cash App Merchants API
Where this information came from

This is an independent, third-party profile of Cash App Requests API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.