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 customers
      • GETRetrieve customer
      • GETRetrieve customer grant
      • GETList customer grants
      • POSTRevoke customer grant
      • Customer
      • POSTEvent: grant.created
      • POSTEvent: grant.status.updated
      • POSTEvent: customer.created
      • POSTEvent: customer.updated
      • POSTEvent: customer.deleted
  • Customer Request API
  • Management API
LogoLogo
Network APICustomers

Event: grant.created

Payload
1{
2  "type": "grant.created",
3  "event_id": "WE_1t7mppyrn2hyiwfzby3pi25tx",
4  "created_at": "2019-08-24T14:15:22Z",
5  "data": {
6    "id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
7    "object": {
8      "grant": {
9        "id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
10        "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
11        "request_id": "GRR_1hrxhz136krcq6ezdte2ha5q",
12        "action": {
13          "amount": 2500,
14          "currency": "USD",
15          "scope_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
16          "type": "ONE_TIME_PAYMENT"
17        },
18        "status": "ACTIVE",
19        "type": "ONE_TIME",
20        "channel": "ONLINE",
21        "created_at": "2019-08-24T14:15:22Z",
22        "updated_at": "2019-08-24T14:15:22Z",
23        "expires_at": "2022-04-01T12:00:00Z"
24      }
25    },
26    "type": "grant"
27  }
28}

When is this event triggered?

This event is created whenever a grant is created. This is caused by a customer request being approved.

Was this page helpful?
Previous

Event: grant.status.updated

Next
Built with

Payload

The payload of this webhook request is an object.
typestringRequired

The type of event that occurred. grant.created 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 grant that was created.

Response

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