Reference information for our payment method webhook events.
payment_method_registration_failed
You can receive a payment_method_registration_failed
webhook when the registration of the direct debit payment method failed for a given paymentMethodId
.
{
"eventType": "payment_method_update",
"eventCode": "payment_method_registration_failed",
"datetime": "2022-01-01T12:34:56.789Z",
"details": {
"id": "3118128a-6792-4b06-bd61-4acf6f6ad6b5", // The paymentMethodId
"reference": "your_reference_here",
"status": "error",
"failedReason": "BANK_CODE",
"failedMessage": "A description of the error"
}
}
We provide additional information regarding the failure in the failedReason
and failedMessage
keys.
payment_method_registration_canceled
You can receive a payment_method_registration_canceled
webhook when the registration of the direct debit payment method was canceled (usually by the owner) for a given paymentMethodId
.
{
"eventType": "payment_method_update",
"eventCode": "payment_method_registration_canceled",
"datetime": "2022-01-01T12:34:56.789Z",
"details": {
"id": "3118128a-6792-4b06-bd61-4acf6f6ad6b5", // The paymentMethodId
"reference": "your_reference_here",
"status": "canceled",
"failedReason": null,
"failedMessage": null
}
}
payment_method_registration_successful
You receive a payment_method_registration_successful
webhook when the registration of the direct debit payment method is successful for a given paymentMethodId
.
{
"eventType": "payment_method_update",
"eventCode": "payment_method_registration_successful",
"datetime": "2022-01-01T12:34:56.789Z",
"details": {
"id": "3118128a-6792-4b06-bd61-4acf6f6ad6b5", // The paymentMethodId
"reference": "your_reference_here",
"status": "active",
"failedReason": null,
"failedMessage": null
}
}