Payment requests, payment links and step-up challenges. Samples show the envelope; data.object of an event that has a snapshot carries the object's fields as of the event (shown here with its type and id). See the envelope.

payment_link.requested#

A payment link is needed for an invoice.

Object: none (the event's own fields).

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b10",
  "object": "event",
  "type": "payment_link.requested",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1000",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}

payment_request.created#

A payment request was created; pay it and use the end-to-end id.

Object: none (the event's own fields).

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b11",
  "object": "event",
  "type": "payment_request.created",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1001",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}

payment_request.paid#

The bank transaction of a payment request was matched.

Object: none (the event's own fields).

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b12",
  "object": "event",
  "type": "payment_request.paid",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1002",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}

payment_request.updated#

A payment request changed status.

Object: none (the event's own fields).

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b13",
  "object": "event",
  "type": "payment_request.updated",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1003",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}

step_up.required#

A step-up confirmation is required for a high-risk action.

Object: none (the event's own fields).

{
  "id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b14",
  "object": "event",
  "type": "step_up.required",
  "apiVersion": "2026-11-01",
  "created": "2026-03-02T10:00:00.000Z",
  "occurredAt": "2026-03-02T09:59:58.000Z",
  "sequence": "1004",
  "livemode": false,
  "platform": "00000000-0000-4000-8000-0000000000aa",
  "company": {
    "id": "00000000-0000-4000-8000-0000000000bb",
    "externalId": "biz-1001"
  },
  "request": null,
  "data": {
    "object": {
      "__typename": "Event",
      "id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
    }
  }
}