Webhook
Payment Status Webhook response Payload
{
"merchantId": "41a77f74-8b67-4f04-be50-c8dd5ad8836f",
"customerId": "Abcam",
"consumerId": "60513141-4d0f-4d3d-9c8a-cc1bd61f40fd",
"merchantName": "John doe",
"paymentIdempotencyId": "ATOA1695808662681",
"status": "COMPLETED",
"statusDetails": null,
"paidAmount": "1005",
"tipAmount": "5.00",
"currency": "GBP",
"createdAt": "2023-09-27T09:57:50.067Z",
"updatedAt": "2023-09-27T09:57:50.067Z",
"taxAmount": 50.25,
"serviceAmount": 30.15,
"storeDetails": {
"id": "ee39ecfa-e336-461c-a957-1adc76ac087c",
"address": "Welwyn Garden City, Hertfordshire",
"locationName": "DEFAULT"
},
"orderId": "003decb3-c35",
"paymentRequestId": "6d1803f8-038a-48f3-8cd4-b44d37a3ab91",
"signatureHash": "1ea6ff07ca90ec4ca34dfd3b420dcdfe5db2d73e3a5de05e5379e8aa325a5e2e",
"errorDescription": "null",
"redirectUrlParams": "{}",
"redirectUrl": "https://paywithatoa.co.uk",
"splitBill": false
}
When configuring a webhook for the payment status event type, the expected payload includes a sample response that will be delivered to your specified endpoint.
Status | Description |
---|---|
COMPLETED | shows that the payment has been processed successfully. Funds have been transferred to the merchant’s account. |
PENDING | shows that the payment is currently in progress and awaiting final confirmation from the bank. |
FAILED | Unsuccessful transactions are marked as failed. The customer will have to retry the payment. |
{
"merchantId": "41a77f74-8b67-4f04-be50-c8dd5ad8836f",
"customerId": "Abcam",
"consumerId": "60513141-4d0f-4d3d-9c8a-cc1bd61f40fd",
"merchantName": "John doe",
"paymentIdempotencyId": "ATOA1695808662681",
"status": "COMPLETED",
"statusDetails": null,
"paidAmount": "1005",
"tipAmount": "5.00",
"currency": "GBP",
"createdAt": "2023-09-27T09:57:50.067Z",
"updatedAt": "2023-09-27T09:57:50.067Z",
"taxAmount": 50.25,
"serviceAmount": 30.15,
"storeDetails": {
"id": "ee39ecfa-e336-461c-a957-1adc76ac087c",
"address": "Welwyn Garden City, Hertfordshire",
"locationName": "DEFAULT"
},
"orderId": "003decb3-c35",
"paymentRequestId": "6d1803f8-038a-48f3-8cd4-b44d37a3ab91",
"signatureHash": "1ea6ff07ca90ec4ca34dfd3b420dcdfe5db2d73e3a5de05e5379e8aa325a5e2e",
"errorDescription": "null",
"redirectUrlParams": "{}",
"redirectUrl": "https://paywithatoa.co.uk",
"splitBill": false
}