{
"webhook_type": "payment_request.payment_failure",
"object_type": "payment_provider_payment_request_payment_error",
"organization_id": "00000000-0000-4000-8000-000000000001",
"payment_provider_payment_request_payment_error": {
"payment_request_id": "00000000-0000-4000-8000-000000000002",
"invoice_ids": [
"00000000-0000-4000-8000-000000000003"
],
"customer_id": "00000000-0000-4000-8000-000000000004",
"external_customer_id": "vfy-rest-c1",
"provider_customer_id": "cus_example",
"payment_provider": null,
"payment_provider_code": null,
"provider_error": {
"message": "Your card was declined.",
"error_code": "card_declined"
}
}
}A payment attempt for a payment request has failed on a payment provider
A payment attempt for a payment request fails, or its Pay link cannot be built. provider_error says why, for example payment_request_invoices_changed.
{
"webhook_type": "payment_request.payment_failure",
"object_type": "payment_provider_payment_request_payment_error",
"organization_id": "00000000-0000-4000-8000-000000000001",
"payment_provider_payment_request_payment_error": {
"payment_request_id": "00000000-0000-4000-8000-000000000002",
"invoice_ids": [
"00000000-0000-4000-8000-000000000003"
],
"customer_id": "00000000-0000-4000-8000-000000000004",
"external_customer_id": "vfy-rest-c1",
"provider_customer_id": "cus_example",
"payment_provider": null,
"payment_provider_code": null,
"provider_error": {
"message": "Your card was declined.",
"error_code": "card_declined"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Signature of the webhook payload
"Ap¶5ɿΣ6ÐfV£Ä\u0015\u0015ºõÔõÔ[DæAâÿüÚ"
Algorithm used to generate the signature
jwt, hmac "hmac"
Unique id of the webhook. It can be used for idempotency
"1a901a90-1a90-1a90-1a90-1a901a901a90"
Body
Details of the payment request and of the provider error
payment_request.payment_failure payment_provider_payment_request_payment_error Unique identifier of the organization, created by Nozle.
"1a901a90-1a90-1a90-1a90-1a901a901a90"
Show child attributes
Show child attributes
Response
Return a 2xx status within 30 seconds to acknowledge the delivery. Any other status, a timeout or a connection error is a failed attempt; Nozle makes up to 3 attempts.