v1

latestOpenAPI 3.0.12026-07-24256962.9 KB

Webhooks Notifications

Retrieve a paginated list of Webhooks Notification by query parameter(s)

get/webhooks

Query parameters

offsetinteger

The number of records you wish to skip before selecting records

limitinteger

Number of items to return

startDatestring date

The start date for the Webhook Notification

endDatestring date

The end date for the Webhook Notification

Headers

Trace-Idstring

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agentstring

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ipstring

The IP address of the end user. Recommended for compliance.

End-User-OSstring

The Operating System of the end user. Recommended for compliance.

End-User-Device-Idstring

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturerstring

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Modelstring

The device model used by the end user. Recommended for compliance.

Response

A list of Webhooks Notifications

Example response

{
  "data": [
    {
      "payload": {
        "id": "d7a2beba-0c2c-42de-9690-26f00ba08339",
        "event": "payment.state_change",
        "data": {
          "id": "09bade02-90b3-4ae2-a2e3-06a66158a0cf",
          "object": "PAYMENT",
          "state": "IN_TRANSIT",
          "timestamp": 1646177561732,
          "payer": {
            "id": "5ccf0f14-f3f9-4166-b29a-a097bb7635c3"
          }
        }
      }
    }
  ],
  "pagination": {
    "limit": 20,
    "total": 1
  }
}