Webhooks Resource

Webhooks allow customers to receive push notifications for changes in payment status, orders, and settlement activities. See Webhook Overview for more information and a complete list of Event Types.

Webhook Resource

{
  "id": string,
  "createOnUtc": timestamp,
  "eventType": string,
  "summary": string,
  "resource": {}
}

Sample Response

{
  "id": "eacabcbf-a7fa-42f1-903a-6ae453a28931",
  "eventType": "payment.statusChanged",
  "createdOnUTC": "2022-01-07T16:30:06Z",
  "summary": "A payment status has been changed.",
  "resource": {
    "id": "123456789",
    "customerId": "customer_01",
    "partnerReference": "optional partner reference data",
    "status": "Created",
    "errorCode": null,
    "createdOn": "2022-01-07T16:30:03Z",
    "lastUpdatedOn": "2022-01-07T16:30:03Z",
    "isDoddFrank": "False"
  }
}