Reference information for our payment request webhook events.
payment_request_failed
You can receive a payment_request_failed
webhook when an error is reported by the payment infrastructure provider for a given paymentRequestId
.
{
"eventType": "payment_request_update",
"eventCode": "payment_request_failed",
"datetime": "2022-01-01T12:34:56.789Z",
"details": {
"id": "3118128a-6792-4b06-bd61-4acf6f6ad6b5", // The paymentRequestId
"reference": "your_reference_here",
"status": "failed",
"failedReason": "BANK_CODE",
"failedMessage": "A description of the error"
}
}
payment_request_successful
You receive a payment_request_successful
webhook when the payment infrastructure provider confirms that the payment was successful for a given paymentRequestId
.
{
"eventType": "payment_request_update",
"eventCode": "payment_request_successful",
"datetime": "2022-01-01T12:34:56.789Z",
"details": {
"id": "3118128a-6792-4b06-bd61-4acf6f6ad6b5", // The paymentRequestId
"reference": "your_reference_here",
"status": "succesful",
"failedReason": null,
"failedMessage": null
}
}
payment_request_canceled
You receive a payment_request_canceled
webhook when the payment request was cancelled by the customer.
{
"eventType": "payment_request_update",
"eventCode": "payment_request_canceled",
"datetime": "2022-01-01T12:34:56.789Z",
"details": {
"id": "3118128a-6792-4b06-bd61-4acf6f6ad6b5", // The paymentRequestId
"reference": "your_reference_here",
"status": "canceled",
"failedReason": null,
"failedMessage": null
}
}
payment_request_chargeback
You receive a payment_request_chargeback
webhook when the payment infrastructure provider reports that the payment resulted in a chargeback by the customer.
{
"eventType": "payment_request_update",
"eventCode": "payment_request_chargeback",
"datetime": "2022-01-01T12:34:56.789Z",
"details": {
"id": "3118128a-6792-4b06-bd61-4acf6f6ad6b5", // The paymentRequestId
"reference": "your_reference_here",
"status": "chargeback",
"failedReason": null,
"failedMessage": null
}
}