Cash App · Schema
webhooks_list-webhook-events_Response_200
Financial ServicesPaymentsUnited StatesFintechNeobankBuy Now Pay LaterPayment AcceptanceDigital WalletConsumer Finance
Properties
| Name | Type | Description |
|---|---|---|
| webhook_events | array | |
| cursor | string | The pagination cursor to be used in a subsequent request. If empty, this is the final response. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/cash-app/main/json-schema/cash-app-webhooks-list-webhook-events-response-200-schema.json",
"title": "webhooks_list-webhook-events_Response_200",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/cash-app-webhooks-api-openapi.yml#/components/schemas/webhooks_list-webhook-events_Response_200",
"type": "object",
"properties": {
"webhook_events": {
"type": "array",
"items": {
"$ref": "#/$defs/WebhookEvent"
}
},
"cursor": {
"type": "string",
"description": "The pagination cursor to be used in a subsequent request. If empty, this is the final response."
}
},
"required": [
"webhook_events"
],
"$defs": {
"Action": {
"oneOf": [
{
"$ref": "#/$defs/OneTimePaymentAction"
},
{
"$ref": "#/$defs/OnFilePaymentAction"
},
{
"$ref": "#/$defs/OnFileDepositAction"
},
{
"$ref": "#/$defs/LinkAccountAction"
}
],
"description": "Represents what the client intends to do to a customer if given authorization.",
"title": "Action"
},
"Address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "First line of the street address, typically including street number, street name, and / or building name.\n\nMin length: `1`\nMax length: `1024`"
},
"address_line_2": {
"type": "string",
"description": "Second line of the address, if any.\n\nMin length: `1`\nMax length: `1024`"
},
"locality": {
"type": "string",
"description": "City or township where the entity is located.\n\nMin length: `1`\nMax length: `1024`"
},
"country": {
"$ref": "#/$defs/Country"
},
"postal_code": {
"type": "string",
"description": "ZIP or postal code.\n\nMin length: `1`\nMax length: `128`"
},
"administrative_district_level_1": {
"type": "string",
"description": "State or province.\n\nMin length: `1`\nMax length: `1024`"
}
},
"required": [
"country"
],
"description": "Where this entity is located",
"title": "Address"
},
"Authorization": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for this authorization issued by Cash App.\n\nMin length: 1 character\nMax length: 128 characters"
},
"amount": {
"type": "integer",
"description": "Total authorized amount after this authorization was processed, in the lowest denomination of currency on the payment."
},
"currency": {
"$ref": "#/$defs/Currency"
},
"status": {
"$ref": "#/$defs/AuthorizationStatus",
"description": "The step of the authorization processing lifecycle that this authorization is currently at.\n\nAllowed values:\n- AUTHORIZED\n- DECLINED"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When this authorization was created, in RFC 3339 format (UTC)."
},
"payment_id": {
"type": "string",
"description": "ID of the payment associated with this authorization"
},
"previous_amount": {
"type": "integer",
"description": "Total authorized amount before this authorization was requested"
},
"reference_id": {
"type": "string",
"description": "A user-defined identifier for this authorization, typically used to associate the authorization with a record in an external system.\n\nMin length: 1\nMax length: 1024"
},
"metadata": {
"$ref": "#/$defs/Metadata"
},
"decline_errors": {
"type": "array",
"items": {
"$ref": "#/$defs/Error"
},
"description": "If the authorization was declined, it contains a list of the reasons why it was declined.\n\nMin number of items: 1"
}
},
"required": [
"id",
"amount",
"currency",
"status",
"created_at",
"payment_id",
"previous_amount"
],
"description": "Represents an authorization update for a payment",
"title": "Authorization"
},
"AuthorizationStatus": {
"type": "string",
"enum": [
"AUTHORIZED",
"DECLINED"
],
"description": "The step of the authorization processing lifecycle that this authorization is currently at.\n\nAllowed values:\n- AUTHORIZED\n- DECLINED",
"title": "AuthorizationStatus"
},
"Category": {
"type": "string",
"description": "The merchant category code associated with the entity. Values are from the [ISO-18245 specification](https://www.iso.org/standard/33365.html).",
"title": "Category"
},
"Channel": {
"type": "string",
"enum": [
"IN_PERSON",
"ONLINE",
"IN_APP"
],
"description": "How the customer is expected to interact with the request.\n\n- `IN_PERSON`: The customer presents or scans a QR code at a physical location to approve the request.\n- `ONLINE`: The customer scans a QR code or is redirected to Cash App from a browser context.\n- `IN_APP`: The customer scans a QR code or is redirected to Cash App from a native mobile application context.",
"title": "Channel"
},
"Country": {
"type": "string",
"enum": [
"US"
],
"description": "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.\n\nCurrent values:\n\n- `US`: United States of America",
"title": "Country"
},
"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.\n\nCurrent values:\n\n- `USD`: United States Dollar",
"title": "Currency"
},
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for this customer issued by Cash App.\n\nMin length: `1`\nMax length: `128`"
},
"cashtag": {
"type": "string",
"description": "Public identifier for the customer on Cash App. [Learn more](https://cash.app/help/us/en-us/3123-cashtags).\n\nMin length: `1`\nMax length: `1024`"
},
"reference_id": {
"type": "string",
"description": "A user-defined identifier for this customer, typically used to associate the customer with a record in an external system. This value can be provided via the `CustomerRequest.customer_metadata.reference_id` attribute. Upon approval of the CustomerRequest, a corresponding customer resource is created with the `reference_id` attribute."
}
},
"required": [
"id",
"cashtag"
],
"title": "Customer"
},
"CustomerMetadata": {
"type": "object",
"properties": {
"reference_id": {
"type": "string",
"description": "The `reference_id` of the customer approving this request. When a customer approves this request, that customer will be associated with this `reference_id`."
}
},
"description": "Metadata to associate with the customer that approves this request.",
"title": "CustomerMetadata"
},
"Dispute": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the dispute issued by Cash App.\n\nMin length: `1`\nMax length: `128`"
},
"payment_id": {
"type": "string",
"description": "ID of the disputed payment.\n\nMin length: `1`\nMax length: `128`"
},
"amount": {
"type": "integer",
"description": "Amount of disputed money, in the lowest denomination of currency on the associated payment.\n\nMin value: `1`"
},
"customer_credited_amount": {
"type": [
"integer",
"null"
],
"description": "The amount credited to the Customer after resolving the dispute. \n\nNote: The amount will be in the lowest denomination of the currency used on the associated payment.\n\nMin value: `0`"
},
"reason": {
"$ref": "#/$defs/DisputeReason",
"description": "4-digit code consisting of 2 letters followed by 2 numbers that indicates why the dispute was created, at a high level.\n\nCurrent values:\n\n- `FR10`: Customer has no knowledge of the payment.\n- `FR11`: Customer has no knowledge of the payment and liability has shifted to the merchant due to collusion, fraud monitoring program thresholds, or any other reason.\n- `PE10`: Payment was processed twice.\n- `PE11`: Payment amount differs from agreed amount.\n- `PE12`: Payment was paid for by another means.\n- `CD10`: Cancelled services.\n- `CD11`: Goods or services differ from what was agreed upon for the payment.\n- `CD12`: The goods or services were not received.\n- `CD13`: The purchase was cancelled or returned, but the refund has not been processed."
},
"settlement_withholding": {
"$ref": "#/$defs/DisputeSettlementWithholding",
"description": "Indicates if the disputed amount has already been withheld from a settlement or not.\n\nCurrent values:\n\n- `NOT_WITHHELD`: The disputed amount has not yet been withheld in a settlement. It may impact future settlements if the dispute is \"lost\" by the merchant.\n\n- `WITHHELD_ALREADY`: The disputed amount was withheld in a prior settlement. This dispute will not impact future settlements."
},
"state": {
"$ref": "#/$defs/DisputeState",
"description": "The step in the dispute lifecycle that this dispute is currently at:\n\n- `RESPONSE_REQUIRED`\n- `NO_RESPONSE_REQUIRED`\n- `PROCESSING`\n- `ACCEPTED`\n- `WON`\n- `PARTIALLY_WON`\n- `LOST`"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When this dispute was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
},
"response_due_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the dispute must be challenged by, after which it will be automatically accepted, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this dispute was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
},
"merchant_id": {
"type": "string",
"description": "ID of the merchant that collected the disputed payment.\n\nMin length: `1`\nMax length: `128`"
}
},
"required": [
"id",
"payment_id",
"amount",
"reason",
"settlement_withholding",
"state",
"created_at",
"updated_at",
"merchant_id"
],
"description": "Represents a dispute initiated by a customer within Cash App or the customer's linked bank",
"title": "Dispute"
},
"DisputeReason": {
"type": "string",
"enum": [
"FR10",
"FR11",
"PE10",
"PE11",
"PE12",
"CD10",
"CD11",
"CD13"
],
"description": "4-digit code consisting of 2 letters followed by 2 numbers that indicates why the dispute was created, at a high level.\n\nCurrent values:\n\n- `FR10`: Customer has no knowledge of the payment.\n- `FR11`: Customer has no knowledge of the payment and liability has shifted to the merchant due to collusion, fraud monitoring program thresholds, or any other reason.\n- `PE10`: Payment was processed twice.\n- `PE11`: Payment amount differs from agreed amount.\n- `PE12`: Payment was paid for by another means.\n- `CD10`: Cancelled services.\n- `CD11`: Goods or services differ from what was agreed upon for the payment.\n- `CD12`: The goods or services were not received.\n- `CD13`: The purchase was cancelled or returned, but the refund has not been processed.",
"title": "DisputeReason"
},
"DisputeSettlementWithholding": {
"type": "string",
"enum": [
"NOT_WITHHELD",
"WITHHELD_ALREADY"
],
"description": "Indicates if the disputed amount has already been withheld from a settlement or not.\n\nCurrent values:\n\n- `NOT_WITHHELD`: The disputed amount has not yet been withheld in a settlement. It may impact future settlements if the dispute is \"lost\" by the merchant.\n\n- `WITHHELD_ALREADY`: The disputed amount was withheld in a prior settlement. This dispute will not impact future settlements.",
"title": "DisputeSettlementWithholding"
},
"DisputeState": {
"type": "string",
"enum": [
"RESPONSE_REQUIRED",
"NO_RESPONSE_REQUIRED",
"PROCESSING",
"ACCEPTED",
"WON",
"PARTIALLY_WON",
"LOST"
],
"description": "The step in the dispute lifecycle that this dispute is currently at:\n\n- `RESPONSE_REQUIRED`\n- `NO_RESPONSE_REQUIRED`\n- `PROCESSING`\n- `ACCEPTED`\n- `WON`\n- `PARTIALLY_WON`\n- `LOST`",
"title": "DisputeState"
},
"Error": {
"type": "object",
"properties": {
"category": {
"$ref": "#/$defs/ErrorCategory",
"description": "The high-level reason the error occurred"
},
"code": {
"type": "string",
"description": "A unique identifier for the specific type of error that occurred. See the Error Code Reference for more information.\n\nMin length: `1`"
},
"detail": {
"type": "string",
"description": "Human-readable description of why the error occurred and how to resolve it.\n\nMin length: `1`"
},
"field": {
"type": "string",
"description": "The field in the request that caused the error, using array and object dot notation.\n\nMin length: `1`"
}
},
"required": [
"category",
"code"
],
"description": "Represents an error encountered during a request to the API.",
"title": "Error"
},
"ErrorCategory": {
"type": "string",
"enum": [
"API_ERROR",
"AUTHENTICATION_ERROR",
"BRAND_ERROR",
"DISPUTE_ERROR",
"MERCHANT_ERROR",
"INVALID_REQUEST_ERROR",
"PAYMENT_PROCESSING_ERROR",
"RATE_LIMIT_ERROR",
"WEBHOOK_ERROR",
"API_KEY_ERROR",
"GRANT_ERROR"
],
"description": "The high-level reason the error occurred",
"title": "ErrorCategory"
},
"EventData": {
"type": "object",
"properties": {
"event_id": {
"type": "string",
"description": "The unique ID of the webhook event."
},
"type": {
"$ref": "#/$defs/EventType"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The timestamp of when the event was created."
},
"data": {
"$ref": "#/$defs/EventDataData",
"description": "The underlying data encapsulated in the event."
}
},
"required": [
"event_id",
"type",
"created_at",
"data"
],
"description": "This represents the data that is delivered to a webhook endpoint.",
"title": "EventData"
},
"EventDataData": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID provided by Cash App for the resource contained in the event."
},
"object": {
"$ref": "#/$defs/EventDataDataObject",
"description": "The snapshot of the resource contained in the event."
},
"type": {
"$ref": "#/$defs/EventDataType"
}
},
"required": [
"id",
"object",
"type"
],
"description": "The underlying data encapsulated in the event.",
"title": "EventDataData"
},
"EventDataDataObject": {
"oneOf": [
{
"$ref": "#/$defs/EventDataDataObject0"
},
{
"$ref": "#/$defs/EventDataDataObject1"
},
{
"$ref": "#/$defs/EventDataDataObject2"
},
{
"$ref": "#/$defs/EventDataDataObject3"
},
{
"$ref": "#/$defs/EventDataDataObject4"
},
{
"$ref": "#/$defs/EventDataDataObject5"
},
{
"$ref": "#/$defs/EventDataDataObject6"
}
],
"description": "The snapshot of the resource contained in the event.",
"title": "EventDataDataObject"
},
"EventDataDataObject0": {
"type": "object",
"properties": {
"customer": {
"$ref": "#/$defs/Customer"
}
},
"title": "EventDataDataObject0"
},
"EventDataDataObject1": {
"type": "object",
"properties": {
"merchant": {
"$ref": "#/$defs/Merchant"
}
},
"title": "EventDataDataObject1"
},
"EventDataDataObject2": {
"type": "object",
"properties": {
"dispute": {
"$ref": "#/$defs/Dispute"
}
},
"title": "EventDataDataObject2"
},
"EventDataDataObject3": {
"type": "object",
"properties": {
"payment": {
"$ref": "#/$defs/Payment"
}
},
"title": "EventDataDataObject3"
},
"EventDataDataObject4": {
"type": "object",
"properties": {
"grant": {
"$ref": "#/$defs/Grant"
}
},
"title": "EventDataDataObject4"
},
"EventDataDataObject5": {
"type": "object",
"properties": {
"refund": {
"$ref": "#/$defs/Refund"
}
},
"title": "EventDataDataObject5"
},
"EventDataDataObject6": {
"type": "object",
"properties": {
"request": {
"$ref": "#/$defs/Request"
}
},
"title": "EventDataDataObject6"
},
"EventDataType": {
"type": "string",
"enum": [
"customer",
"merchant",
"dispute",
"grant",
"payment",
"refund",
"request"
],
"description": "The type of the resource contained in the event.",
"title": "EventDataType"
},
"EventStatus": {
"type": "string",
"enum": [
"PENDING",
"FAILED",
"SUCCESS"
],
"description": "The status of an event that was delivered to a webhook endpoint. The status can either be PENDING, SUCCESS, or FAILED.\n\nPENDING: The webhook event has been dispatched and is in the process of being delivered to the endpoint. If the event has failed and is being retried, it will continue to be in the PENDING status.\n\nSUCCESS: The webhook event has been delivered to the endpoint and we've received receipt of the delivery from the client's endpoint (e.g. 200OK).\n\nFAILED: The webhook event has failed all delivery attempts for 72 hours. No more deliveries will be attempted.",
"title": "EventStatus"
},
"EventType": {
"type": "string",
"enum": [
"customer.created",
"customer.deleted",
"customer.updated",
"customer_request.state.updated",
"dispute.created",
"dispute.state.updated",
"grant.created",
"grant.status.updated",
"merchant.status.updated",
"payment.status.updated",
"refund.status.updated"
],
"description": "The type of event that will be sent to the webhook endpoint.",
"title": "EventType"
},
"FeeRate": {
"type": "object",
"properties": {
"basis_points": {
"type": "integer",
"description": "The variable fee charged for processing the payment expressed as 1/100th of a percentage."
},
"fixed_amount": {
"type": "integer",
"description": "The amount charged for processing the payment, in the lowest denomination of currency on the payment.\n **Note: The currency for the fee is found on the fee plan.**"
}
},
"description": "A fee rate contains the components of a fee charged by Cash App to partners for a given payment.",
"title": "FeeRate"
},
"Grant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for this grant issued by Cash App.\n\nMin length: `1`\nMax length: `256`"
},
"customer_id": {
"type": "string",
"description": "ID of the customer that approved this grant.\n\nMin length: `1`\nMax length: `128`"
},
"request_id": {
"type": "string",
"description": "A unique identifier issued by Cash App for the customer request that resulted in the creation of this grant.\n\nMin length: `1`\nMax length: `128`"
},
"action": {
"$ref": "#/$defs/Action"
},
"status": {
"$ref": "#/$defs/GrantStatus",
"description": "Describes whether or not this grant can be used to perform the action associated with it.\n\nIf `ACTIVE`, it can be used to perform the action.\n\nIf `EXPIRED`, it may no longer be used to perform the action due to the current time being past the \"expires_at\" time.\n\nIf `CONSUMED`, it was already redeemed to perform the action and cannot be used again.\n\nIf `REVOKED`, the customer or merchant explicitly unauthorized the grant, preventing it from being used to perform the action."
},
"type": {
"$ref": "#/$defs/GrantType",
"description": "Describes whether this grant can be only be used once (`ONE_TIME`) or repeatedly (`EXTENDED`)."
},
"channel": {
"$ref": "#/$defs/Channel"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When this grant was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this grant was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
},
"expires_at": {
"type": "string",
"format": "date-time",
"description": "If present, indicates when the grant's status will become `EXPIRED`, preventing a client from using it to create payments or refunds.\n\nThe timestamp is in the [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
}
},
"required": [
"id",
"customer_id",
"request_id",
"action",
"status",
"type",
"channel",
"created_at",
"updated_at"
],
"description": "Describes a grant that can be used to perform actions specified in a customer request using the Network API.",
"title": "Grant"
},
"GrantStatus": {
"type": "string",
"enum": [
"ACTIVE",
"CONSUMED",
"REVOKED",
"EXPIRED"
],
"description": "Describes whether or not this grant can be used to perform the action associated with it.\n\nIf `ACTIVE`, it can be used to perform the action.\n\nIf `EXPIRED`, it may no longer be used to perform the action due to the current time being past the \"expires_at\" time.\n\nIf `CONSUMED`, it was already redeemed to perform the action and cannot be used again.\n\nIf `REVOKED`, the customer or merchant explicitly unauthorized the grant, preventing it from being used to perform the action.",
"title": "GrantStatus"
},
"GrantType": {
"type": "string",
"enum": [
"ONE_TIME",
"EXTENDED"
],
"description": "Describes whether this grant can be only be used once (`ONE_TIME`) or repeatedly (`EXTENDED`).",
"title": "GrantType"
},
"LinkAccountAction": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/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.",
"title": "LinkAccountAction"
},
"LinkAccountActionType": {
"type": "string",
"enum": [
"LINK_ACCOUNT"
],
"description": "The type of the action (`LINK_ACCOUNT`).",
"title": "LinkAccountActionType"
},
"Merchant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the merchant issued by Cash App.\n\nMin length: `1`\nMax length: `128`"
},
"brand_id": {
"type": "string",
"description": "ID of the brand associated with this merchant.\n\nMin length: `1`\nMax length: `128`"
},
"name": {
"type": "string",
"description": "The name of the individual or business entity associated with the merchant.\n\nMin length: `1`\nMax length: `1024`"
},
"country": {
"$ref": "#/$defs/Country"
},
"currency": {
"$ref": "#/$defs/Currency"
},
"category": {
"$ref": "#/$defs/Category"
},
"reference_id": {
"type": "string",
"description": "A user-defined identifier for this merchant, typically used to associate the merchant with a record in an external system. Independent from the [brand reference_id](https://developers.cash.app/docs/api/network-api/operations/create-a-brand#request-body).\n\nMin length: `1`\nMax length: `1024`"
},
"status": {
"$ref": "#/$defs/MerchantStatus",
"description": "Whether or not this merchant can be used to accept payments or issue refunds.\n\n- `ACTIVE`: The merchant can accept payments or issue refunds.\n- `RISK_DISABLED`: Cash App Pay blocked this merchant due to them being high risk. There is no way to re-enable them programmaticaly.\n- `COMPLIANCE_DISABLED`: Cash App Pay blocked this merchant due to them not following the terms of service, Program Rules, or local laws. There is no way to re-enable them programmaticaly.\n- `CLIENT_DISABLED`: The client called the [UpdateMerchant](Network-API.v1.yaml/paths/~1merchants~1{merchant_id}/patch) endpoint and disabled this merchant, preventing it from being able to handle payments or refunds. To reverse this, call the endpoint again with the status field set to `ACTIVE`.\n- `PENDING`: The merchant is not ready to accept payments or refunds yet; the registration process is still running."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When this merchant was created, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this merchant was last updated, in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format (UTC)."
},
"address": {
"$ref": "#/$defs/Address"
},
"site_url": {
"type": "string",
"format": "uri",
"description": "The URL of the website, if this merchant is for an eCommerce site.\n\nMin length: `8`\nMax length: `8000`"
},
"metadata": {
"$ref": "#/$defs/Metadata"
},
"default_fee_plans": {
"$ref": "#/$defs/MerchantFeePlans"
}
},
"required": [
"id",
"brand_id",
"name",
"country",
"currency",
"category",
"reference_id",
"status",
"created_at",
"updated_at",
"address"
],
"description": "A merchant represents a depository account when processing payments from Cash App customers. Merchants do not have direct access to Cash App, so processed payments are stored in this account until they are ready for settlement.",
"title": "Merchant"
},
"MerchantFeePlans": {
"type": "object",
"properties": {
"in_app_fee_plan_id": {
"type": "string",
"description": "The fee plan ID identifying the fee plan that will be used for all in-app payments."
},
"in_person_fee_plan_id": {
"type": "string",
"description": "The fee plan ID identifying the fee plan that will be used for all in-person payments."
},
"online_fee_plan_id": {
"type": "string",
"description": "The fee plan ID identifying the fee plan that will be used for all online payments."
}
},
"description": "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 processing payments for each channel. You can use the Fee Plans API to get all the fee information for each fee plan.",
"title": "MerchantFeePlans"
},
"MerchantStatus": {
"type": "string",
"enum": [
"ACTIVE",
"RISK_DISABLED",
"COMPLIANCE_DISABLED",
"CLIENT_DISABLED",
"PENDING"
],
"description": "Whether or not this merchant can be used to accept payments or issue refunds.\n\n- `ACTIVE`: The merchant can accept payments or issue refunds.\n- `RISK_DISABLED`: Cash App Pay blocked this merchant due to them being high risk. There is no way to re-enable them programmaticaly.\n- `COMPLIANCE_DISABLED`: Cash App Pay blocked this merchant due to them not following the terms of service, Program Rules, or local laws. There is no way to re-enable them programmaticaly.\n- `CLIENT_DISABLED`: The client called the [UpdateMerchant](Network-API.v1.yaml/paths/~1merchants~1{merchant_id}/patch) endpoint and disabled this merchant, preventing it from being able to handle payments or refunds. To reverse this, call the endpoint again with the status field set to `ACTIVE`.\n- `PENDING`: The merchant is not ready to accept payments or refunds yet; the registration process is still running.",
"title": "MerchantStatus"
},
"Metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Freeform key-value pairs of arbitrary data associated with this resource.\n\nKeys and values must be passed as strings and not contain any personally identifiable information (PII).\n\nMin keys: `0`\nMax keys: `50`\n\n> Note: Nested keys are not supported.",
"title": "Metadata"
},
"OnFileDepositAction": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/OnFileDepositActionType",
"description": "The type of the action (`ON_FILE_DEPOSIT`)."
},
"scope_id": {
"type": "string",
"description": "ID of the client or brand that indicates the set of merchants that will deposit to customers.\n\nIf a client ID is passed, the grant from this action can be used to create a deposit for any merchant owned by the client.\n\nIf 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.\nMin length: `1`\nMax 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
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cash-app/refs/heads/main/json-schema/cash-app-webhooks-list-webhook-events-response-200-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cash-app-webhooks-list-webhook-events-response-200"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.