For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Network API
      • GETList refunds
      • POSTCreate refund
      • GETRetrieve refund
      • POSTCapture refund
      • POSTVoid refund
      • POSTVoid refund by idempotency key
      • Refund
      • POSTEvent: refund.status.updated
  • Customer Request API
  • Management API
LogoLogo
Network APIRefunds

Event: refund.status.updated

Payload
1{
2  "type": "refund.status.updated",
3  "event_id": "WE_e7amr4aqxkueuj19uouje8kow",
4  "created_at": "2019-08-24T14:15:22Z",
5  "data": {
6    "id": "PWCR_da1v3j4p3z15y47adpzzq0whj",
7    "object": {
8      "refund": {
9        "id": "PWCR_da1v3j4p3z15y47adpzzq0whj",
10        "amount": 1000,
11        "currency": "USD",
12        "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
13        "merchant_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
14        "status": "CAPTURED",
15        "created_at": "2019-08-24T14:15:22Z",
16        "updated_at": "2019-08-24T14:15:22Z",
17        "payment_id": "PWC_4nn21zy6t0v2yhqg5bvhk7xkq"
18      }
19    },
20    "type": "refund"
21  }
22}
**When is this event triggered?** This event is created whenever a refund status is changed. The status change can be due to a couple different things: - An API client-initiated action to void or capture the refund - A refund auto-voiding after 7 days of not being captured
Was this page helpful?
Previous

List disputes

Next
Built with

When is this event triggered?

This event is created whenever a refund status is changed. The status change can be due to a couple different things:

  • An API client-initiated action to void or capture the refund
  • A refund auto-voiding after 7 days of not being captured

Payload

The payload of this webhook request is an object.
typestringRequired

The type of event that occurred. refund.status.updated for this event.

event_idstringRequired
A unique identifier provided by Cash App for the event.
created_atstringRequiredformat: "date-time"

When this event occured in RFC 3339 format (UTC).

The time that the event is delivered may be significantly later than this timestamp due to webhooks being retried for up to 72 hours.

dataobjectRequired
Data about the refund that had a status change.

Response

200
any
Return a 200 status to indicate that the data was received successfully.