Use the Pay1st Console to generate the Webhooks and Callbacks for your integrations
Used in Gateway Integration
Overview
Partners will receive webhook notifications when processing refunds.
Refund Webhook Configuration
Partners need to configure a webhook URL for receiving refund notifications. This can be done either in the Pay1st Console or as part of the Refund Request API.
| Name | Description | Type |
|---|---|---|
| Refund Webhook URL | This is used in order to send refund updates to the Partner backend server. | String |
Sample Webhook Payload
{
"refundReference": "R-67890",
"transactionReference": "C-12345-T",
"partnerReference": "PTN_REF_001",
"partnerRefundReference": "PTN_REF_R001",
"refundAmount": 50.00,
"currencyCode": "ZAR",
"status": "SUCCESSFUL",
"reason": "Customer requested refund",
"createdDate": "2026-03-10T12:05:00Z"
}Payment Webhook Event List of Fields
The table below lists all the fields available in payment webhook events:
| Name | Type | Description |
|---|---|---|
| refundReference | String | A unique identifier that identifies the refund transaction |
| transactionReference | String | The original Pay1st transaction reference for the request |
| partnerReference | String | The original reference provided by the partner in the transaction |
| partnerRefundReference | String | The partner's reference provided by the partner in the refund request |
| refundAmount | Number | The amount of the refund |
| currencyCode | String | The currency code used for the refund |
| status | String | Indicates the status of the refund. Possible values are
|
| reason | String | Describes the reason for the refund |
| createdDate | String | The date that the refund has been created |