Recover
...
API Reference
Merchant Endpoints

End of Dunning

1min
POST
https://api.<merchant-url>.com/webhooks/end-of-dunning
An example of a url the merchant would create to receive these events.
Butter will send webhooks via HTTP POST requests to this endpoint when dunning is complete and we will no longer make attempts to recover the payment.
Authentication
basic_auth
x-api-key
Header Parameters
X-Butter-Webhook-Type
X-Butter-Webhook-Expires
X-Butter-Webhook-Signature
X-Butter-Webhook-Deduplication-ID
Body Parameters
body
*
Description
A notification that the dunning period has elapsed for the specified invoice.
timestamp
invoice_id
recovered
custom
Responses
200
Event Delivered Successfully
Description
The webhook event was delivered successfully.
detail
500
Event Not Delivered
Description
The webhook event failed to deliver due to an internal server error. Webhooks will retry delivery every 12 hours for 7 days on failure.
detail




Updated 21 Nov 2024
Doc contributor
Did this page help you?