Refund Events

To receive event notifications for a given Refund, you must include your Webhooks destination URL in the Make Refund API request body.

No Webhooks subscription configuration is required, instead you use the merchantWebhooksUrl parameter to control whether and where the Webhooks will be sent as follows:

If the merchantWebhooksUrl parameter is excluded from the API request body, Webhooks will not be sent out for the created Refund resource.
If the merchantWebhooksUrl parameter is included in the API request body, all the Webhooks related to this Refund resource will be sent out to the specified URL.

You may direct our Webhooks to any URL of your choosing, as our platform offers complete flexibility in using static or dynamic URLs.

We provide the following list of PayTo Refund related events:

PayTo Refund Completed

This event notification will be sent when a PayTo Refund has been successfully settled.

{
  "EventId": "9ef44096-1ed1-4ad5-974b-22dff3d1c18e",
  "EventType": "Refund.Completed",
  "PublishedAt": "2024-07-02T03:54:13.9572704Z",
  "Payload": {
    "RefundId": "d7f939c7-9d2f-4e55-aa0c-e1bba89650e8",
    "PaymentId": "4e6f2f65-a430-423e-859a-09564ff0c65e",
    "Amount": 500,
    "Reference": "#12345",
    "Description": "Football practice",
    "NppPublishedAt": "2024-07-02T03:54:12.074Z",    
    "SchemaVersion": "1.0.0"
  },
  "SchemaVersion": "1.0.0"
}

PayTo Refund Rejected

This event notification will be sent when a PayTo Refund has been rejected.

{
  "EventId": "d2e99909-64e6-474f-a313-44703a32fd09",
  "EventType": "Payment.Rejected",
  "PublishedAt": "2024-07-02T04:08:19.2964618Z",
  "Payload": {
    "PaymentId": "21c202d1-72c6-4a2a-91f6-153126ceb29c",
    "InstrumentId": "b4f1f80e-5802-4480-9e47-be5cbfe7b7c0",
    "Amount": 1,    
    "RejectionReason": {
      "Code": "SYS",
      "Title": "System Error",
      "Detail": "A system error occured. Contact Wpay for technical assistance."
    },
    "NppPublishedAt": "2024-07-02T04:08:19.1461833Z",    
    "SchemaVersion": "1.0.0"
  },
  "SchemaVersion": "1.0.0"
}