Webhook
Refund Status Webhook response Payload
Webhook
Refund Status Webhook response Payload
{
"refundId": "c4e92a73-5f12-47c9-8b31-6e54f2d8a91c",
"paymentRequestId": "8f2471db-3456-9cd8-eff2-1a3b5c7d9e0f",
"paymentIdempotencyId": "ATOA1893245678912",
"status": "COMPLETED",
"paidAmount": 785.25,
"refundAmount": 50.75,
"currency": "GBP",
"refundNotes": "Customer requested partial refund",
"orderId": "892365417",
"createdAt": "2025-04-12T09:23:45.612Z",
"updatedAt": "2025-04-12T09:25:18.743Z",
"signatureHash": "9a2b8c4d6e3f1a5b7c9d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b"
}
When configuring a webhook for the refund status event type, the expected payload includes a sample response that will be delivered to your specified endpoint.
| Status | Description |
|---|---|
| COMPLETED | shows that the refund request has been completed and credited to the customer’s bank acccount |
| FAILED | indicates that the refund request could not be processed at this time |
| CANCELLED | shows that the refund request has been cancelled by one of your user |
signatureHash is used to verify the authenticity of the webhook call
{
"refundId": "c4e92a73-5f12-47c9-8b31-6e54f2d8a91c",
"paymentRequestId": "8f2471db-3456-9cd8-eff2-1a3b5c7d9e0f",
"paymentIdempotencyId": "ATOA1893245678912",
"status": "COMPLETED",
"paidAmount": 785.25,
"refundAmount": 50.75,
"currency": "GBP",
"refundNotes": "Customer requested partial refund",
"orderId": "892365417",
"createdAt": "2025-04-12T09:23:45.612Z",
"updatedAt": "2025-04-12T09:25:18.743Z",
"signatureHash": "9a2b8c4d6e3f1a5b7c9d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b"
}