Cash App Webhooks 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 Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 3 paths,
and defines 77 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/management/v1, https://sandbox.api.cash.app/management/v1.
The identity and technical contract details declared by the specification.
Category
string
The merchant category code associated with the entity. Values are from the [ISO-18245 specification](https://www.iso.org/standard/33365.html).
WebhookEventsGetParametersStatus
string
EventDataDataObject5
object
1 property
Payment
object
22 properties
13 required
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…
WebhookEndpointStatus
string
The approval status of a webhook endpoint. Once a webhook endpoint is approved, Cash App will deliver events to that webhook endpoint.
webhooks_list-webhook-events_Response_200
object
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
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.…
PaymentStatus
string
The step of the payment processing lifecycle that this payment is currently at. - AUTHORIZED - CAPTURED - VOIDED - DECLINED
EventDataDataObject1
object
1 property
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…
LinkAccountActionType
string
The type of the action (LINKACCOUNT).
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
webhooks_update-webhook-endpoint_Response_200
object
1 property
1 required
webhooks_retrieve-webhook-endpoint_Response_200
object
1 property
1 required
PaymentEnrichmentsInitiation
object
If present, provides information about transaction initiation.
1 property
1 required
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
WebhookEventsGetParametersEventType
string
Address
object
Where this entity is located
6 properties
1 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
PaymentEnrichmentsInitiationActor
string
The party who initiated the payment. - CUSTOMER - MERCHANT
webhooks_delete-webhook-endpoint_Response_200
object
Empty response body
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…
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
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
RefundStatus
string
The step of the refund processing lifecycle that this refund is currently at. - AUTHORIZED - CAPTURED - VOIDED - DECLINED
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…
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…
EventDataDataObject2
object
1 property
ErrorCategory
string
The high-level reason the error occurred
WebhookEndpoint
object
The events will be sent to this webhook endpoint.
10 properties
8 required
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
EventType
string
The type of event that will be sent to the webhook endpoint.
EventDataType
string
The type of the resource contained in the event.
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
Request
object
Describes a request from a client to perform a given action on a customer's account.
16 properties
9 required
WebhookEndpointsPostRequestBodyContentApplicationJsonSchemaWebhookEndpoint
object
6 properties
3 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
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…
RequestOrigin
object
Metadata describing how the customer request was created.
2 properties
1 required
EventDataDataObject0
object
1 property
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
FeeRate
object
A fee rate contains the components of a fee charged by Cash App to partners for a given payment.
2 properties
ApiVersion
string
Represents the API version.
OnFileDepositActionType
string
The type of the action (ONFILEDEPOSIT).
ErrorResponse
object
1 property
1 required
AuthorizationStatus
string
The step of the authorization processing lifecycle that this authorization is currently at. Allowed values: - AUTHORIZED - DECLINED
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…
Authorization
object
Represents an authorization update for a payment
10 properties
7 required
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…
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…
EventDataDataObject
The snapshot of the resource contained in the event.
EventDataDataObject4
object
1 property
LinkAccountAction
object
Describes an intent for a client to manage a customer's merchant profiles in Cash App.
1 property
1 required
webhooks_list-webhook-endpoints_Response_200
object
2 properties
1 required
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
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…
Customer
object
3 properties
2 required
webhooks_create-webhook-endpoint_Response_201
object
1 property
1 required
Error
object
Represents an error encountered during a request to the API.
4 properties
2 required
Refund
object
13 properties
8 required
GrantType
string
Describes whether this grant can be only be used once (ONETIME) or repeatedly (EXTENDED).
OneTimePaymentActionType
string
The type of the action (ONETIMEPAYMENT).
PaymentEnrichmentsRestrictedCategoriesItems
string
CustomerMetadata
object
Metadata to associate with the customer that approves this request.
1 property
EventDataDataObject6
object
1 property
EventDataDataObject3
object
1 property
Dispute
object
Represents a dispute initiated by a customer within Cash App or the customer's linked bank
11 properties
9 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
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
DisputeState
string
The step in the dispute lifecycle that this dispute is currently at: - RESPONSEREQUIRED - NORESPONSEREQUIRED - PROCESSING - ACCEPTED - WON - PARTIALLYWON - LOST
WebhookEndpointsWebhookEndpointIdPatchRequestBodyContentApplicationJsonSchemaWebhookEndpoint
object
6 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cash App publishes across the network.
