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
  • Customer Request API
      • POSTCreate request
      • GETRetrieve request
      • PATCHUpdate request
      • POSTEvent: customer_request.state.updated
  • Management API
LogoLogo
Customer Request APIRequests

Event: customer_request.state.updated

Payload
1{
2  "type": "customer_request.state.updated",
3  "event_id": "WE_a61xp8sny73j557bacysv4wkh",
4  "created_at": "2019-08-24T14:15:22Z",
5  "data": {
6    "id": "GRR_1hrxhz136krcq6ezdte2ha5q",
7    "object": {
8      "request": {
9        "id": "GRR_1hrxhz136krcq6ezdte2ha5q",
10        "status": "APPROVED",
11        "actions": [
12          {
13            "amount": 2500,
14            "currency": "USD",
15            "scope_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
16            "type": "ONE_TIME_PAYMENT"
17          }
18        ],
19        "redirect_url": "https://example.com",
20        "created_at": "2019-08-24T14:15:22Z",
21        "updated_at": "2019-08-24T14:15:22Z",
22        "expires_at": "2033-01-01T12:20:00Z",
23        "origin": {
24          "type": "DIRECT"
25        },
26        "channel": "ONLINE"
27      }
28    },
29    "type": "customer_request"
30  }
31}

When is this event triggered?

This event is created whenever a customer request’s state is updated. This is typically caused by a customer approving or declining the request.

Was this page helpful?
Previous

Action

Next
Built with

Payload

The payload of this webhook request is an object.
typestringRequired

The type of event that occurred. customer_request.state.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 customer request that was updated.

Response

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