End of Dunning
1 min
POST
https://api.<merchant-url>.com/webhooks/end-of-dunning
X-Butter-Webhook-Typestring
X-Butter-Webhook-ExpirationintegerThe unix timestamp that the webhook signature expires at.
X-Butter-Webhook-Signaturestring<hmac>The signature the merchant can use for validating the security of the webhook.
X-Butter-Webhook-Deduplication-IDstring<md5>A unique identifier that can be used to deduplicate the webhook.
bodyobjectA notification that the dunning period has elapsed for the specified invoice.
200Event Delivered Successfully
500Event Not Delivered
curl --request POST \
--url https://api.<merchant-url>.com/webhooks/end-of-dunning \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-butter-webhook-expiration: 1698251668' \
--header 'x-butter-webhook-signature: 06cf8a25ef73841fea0b20f13499f173e7767da53cccba2412b261816515f30d' \
--header 'x-butter-webhook-deduplication-id: 47bce5c74f589f4867dbd57e9ca9f808' \
--data '{
"timestamp": "2023-10-25T03:57:26Z",
"invoice_id": "inv_12345",
"recovered": true
}'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. Butter guarantees 'at least once' delivery of events, and provides a deduplication ID to enable integrators to handle duplicate event delivery.
Note - The Butter webhook payload is a simple JSON object containing the attributes specified below. The payload does not contain a higher-level 'body' object that contains the other attributes.
Add field values in the boxes below to create an example payload on the right side of the screen.