Cash App Pay Management API
REST API that controls scoped API keys and webhooks, automating key aspects of a Cash App Pay integration including least-privileged microservice access.
Cash App Pay Management 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 API Keys, Webhooks, and Management API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 11 operations across 6 paths, organized into 3 resource areas, and defines 98 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/management/v1, https://sandbox.api.cash.app/management/v1.
11 operations
6 paths
98 schemas
2 DELETE5 GET1 PATCH3 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 11
Across 6 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 1 PATCH, 3 POST. They span 3 resource areas: apiKeys, Webhooks, requestChains. Each is listed below with its method, path, parameters, and response codes.
apiKeys 4
GET
/api-keys
List API keys
POST
/api-keys
Create API key
GET
/api-keys/{api_key_id}
Retrieve API key
DELETE
/api-keys/{api_key_id}
Delete API key
Webhooks 6
GET
/webhook-endpoints
List webhook endpoints
POST
/webhook-endpoints
Create webhook endpoint
GET
/webhook-endpoints/{webhook_endpoint_id}
Retrieve webhook endpoint
PATCH
/webhook-endpoints/{webhook_endpoint_id}
Update webhook endpoint
DELETE
/webhook-endpoints/{webhook_endpoint_id}
Delete webhook endpoint
GET
/webhook-events
List webhook events
requestChains 1
POST
/request-chains
Create request chain
Schemas 98
The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are Payment (22 properties), Request (16 properties), Merchant (14 properties), Refund (13 properties). Each schema is shown below with its type and property counts.
ScopesItems
string
Scopes
array
An array of permissions granted to the API key. Current values: - APIKEYSREAD: Permits listing API keys and retrieving individual keys. - APIKEYSWRITE: Permits…
ApiKey
object
5 properties
4 required
apiKeys_list-api-keys_Response_200
object
2 properties
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
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…
ApiKeysPostRequestBodyContentApplicationJsonSchemaApiKey
object
Details about the API key to create.
2 properties
1 required
apiKeys_create-api-key_Response_201
object
2 properties
2 required
apiKeys_retrieve-api-key_Response_200
object
1 property
1 required
apiKeys_delete-api-key_Response_200
object
Empty response body
EventType
string
The type of event that will be sent to the webhook endpoint.
ApiVersion
string
Represents the API version.
EventConfiguration
object
Represents a supported event type and the API version that the event of this type should be serialized to.
2 properties
2 required
WebhookEndpointStatus
string
The approval status of a webhook endpoint. Once a webhook endpoint is approved, Cash App will deliver events to that webhook endpoint.
WebhookEndpoint
object
The events will be sent to this webhook endpoint.
10 properties
8 required
webhooks_list-webhook-endpoints_Response_200
object
2 properties
1 required
WebhookEndpointsPostRequestBodyContentApplicationJsonSchemaWebhookEndpoint
object
6 properties
3 required
webhooks_create-webhook-endpoint_Response_201
object
1 property
1 required
webhooks_retrieve-webhook-endpoint_Response_200
object
1 property
1 required
WebhookEndpointsWebhookEndpointIdPatchRequestBodyContentApplicationJsonSchemaWebhookEndpoint
object
6 properties
webhooks_update-webhook-endpoint_Response_200
object
1 property
1 required
webhooks_delete-webhook-endpoint_Response_200
object
Empty response body
WebhookEventsGetParametersStatus
string
WebhookEventsGetParametersEventType
string
EventStatus
string
The status of an event that was delivered to a webhook endpoint. The status can either be PENDING, SUCCESS, or FAILED. PENDING: The webhook event has been disp…
Customer
object
3 properties
2 required
EventDataDataObject0
object
1 property
Country
string
Indicates the country associated with an entity. Values are from the [ISO-3166 Alpha-2](https://www.iso.org/iso-3166-country-codes.html) specification. Current…
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…
Category
string
The merchant category code associated with the entity. Values are from the [ISO-18245 specification](https://www.iso.org/standard/33365.html).
MerchantStatus
string
Whether or not this merchant can be used to accept payments or issue refunds. - ACTIVE: The merchant can accept payments or issue refunds. - RISKDISABLED: Cash…
Address
object
Where this entity is located
6 properties
1 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…
MerchantFeePlans
object
Merchant fee plans contains the IDs of the different fee plans for a merchant. These IDs represent the processing fees that merchants will be charged for proce…
3 properties
Merchant
object
A merchant represents a depository account when processing payments from Cash App customers. Merchants do not have direct access to Cash App, so processed paym…
14 properties
11 required
EventDataDataObject1
object
1 property
DisputeReason
string
4-digit code consisting of 2 letters followed by 2 numbers that indicates why the dispute was created, at a high level. Current values: - FR10: Customer has no…
DisputeSettlementWithholding
string
Indicates if the disputed amount has already been withheld from a settlement or not. Current values: - NOTWITHHELD: The disputed amount has not yet been withhe…
DisputeState
string
The step in the dispute lifecycle that this dispute is currently at: - RESPONSEREQUIRED - NORESPONSEREQUIRED - PROCESSING - ACCEPTED - WON - PARTIALLYWON - LOST
Dispute
object
Represents a dispute initiated by a customer within Cash App or the customer's linked bank
11 properties
9 required
EventDataDataObject2
object
1 property
PaymentStatus
string
The step of the payment processing lifecycle that this payment is currently at. - AUTHORIZED - CAPTURED - VOIDED - DECLINED
PaymentEnrichmentsInitiationActor
string
The party who initiated the payment. - CUSTOMER - MERCHANT
PaymentEnrichmentsInitiation
object
If present, provides information about transaction initiation.
1 property
1 required
PaymentEnrichmentsRestrictedCategoriesItems
string
PaymentEnrichments
object
Describes optional fields beyond core payment information to supplement payment processing. Enrichments provide additional context about a payment, which can i…
4 properties
FeeRate
object
A fee rate contains the components of a fee charged by Cash App to partners for a given payment.
2 properties
AuthorizationStatus
string
The step of the authorization processing lifecycle that this authorization is currently at. Allowed values: - AUTHORIZED - DECLINED
Authorization
object
Represents an authorization update for a payment
10 properties
7 required
Payment
object
22 properties
13 required
EventDataDataObject3
object
1 property
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
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
Action
Represents what the client intends to do to a customer if given authorization.
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).
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.…
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
EventDataDataObject4
object
1 property
RefundStatus
string
The step of the refund processing lifecycle that this refund is currently at. - AUTHORIZED - CAPTURED - VOIDED - DECLINED
Refund
object
13 properties
8 required
EventDataDataObject5
object
1 property
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
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
CustomerMetadata
object
Metadata to associate with the customer that approves this request.
1 property
Request
object
Describes a request from a client to perform a given action on a customer's account.
16 properties
9 required
EventDataDataObject6
object
1 property
EventDataDataObject
The snapshot of the resource contained in the event.
EventDataType
string
The type of the resource contained in the event.
EventDataData
object
The underlying data encapsulated in the event.
3 properties
3 required
EventData
object
This represents the data that is delivered to a webhook endpoint.
4 properties
4 required
WebhookEvent
object
The event that is being sent to a particular webhook endpoint. The event is either in the process of being delivered (PENDING), has been successfully delivered…
9 properties
9 required
webhooks_list-webhook-events_Response_200
object
2 properties
1 required
RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsMethod
string
HTTP method of the request
RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsPathParams
object
A map of path parameters. The keys represent variables from the path. The value fields allow for Accessing a previous response's value.
RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsQueryParams
object
A map of query parameters. The value fields allow for Accessing a previous response's value.
RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItemsBody
object
The body that is required for the requested endpoint. The value fields allow for Accessing a previous response's value.
RequestChainsPostRequestBodyContentApplicationJsonSchemaRequestsItems
object
6 properties
3 required
RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsRequestsItems
object
1 property
1 required
RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItemsExecutionMode
string
Execution mode of the requests in a chain
RequestChainsPostRequestBodyContentApplicationJsonSchemaChainsItems
object
2 properties
2 required
ResponseExecutionStatus
string
Execution status of the request
ResponseMethod
string
HTTP method of the request
ResponseBody
object
Response body of the requested endpoint
Response
object
7 properties
4 required
requestChains_create-request-chain_Response_201
object
1 property
1 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 Customer Request 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)
#API Keys#Webhooks#Management API