Event: grant.created | Welcome to cash-app Documentation

{
  "type": "grant.created",
  "event_id": "WE_1t7mppyrn2hyiwfzby3pi25tx",
  "created_at": "2019-08-24T14:15:22Z",
  "data": {
    "id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
    "object": {
      "grant": {
        "id": "GRG_221243dc6985a6819ff6950c1a21332f7bc4a46ebd49b5a7002908ab768e8e5ff7831e084d0d2c9d8d939793b55eff50",
        "customer_id": "CST_AQmxh4y_QGoNNIG5NUw0jttqyYedL1LklACQdyJ3H-Vs6WmLtP6A_C7XjQNohvY",
        "request_id": "GRR_1hrxhz136krcq6ezdte2ha5q",
        "action": {
          "amount": 2500,
          "currency": "USD",
          "scope_id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
          "type": "ONE_TIME_PAYMENT"
        },
        "status": "ACTIVE",
        "type": "ONE_TIME",
        "channel": "ONLINE",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "expires_at": "2022-04-01T12:00:00Z"
      }
    },
    "type": "grant"
  }
}

When is this event triggered?

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

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.