Void Payment Webhook
Upon a successful request to void a payment, Donary Enterprise will send the following payload to the endpoint configured in the PaymentStatusUpdateWebhookEndpoint setting. This endpoint must match the URL configured in the customer's system.
Payload
| Name | Type | Description | |
|---|---|---|---|
| orgGuid | string | Organization's unique identifier. | |
| statusDateTime | string | Void payment date and time, in UTC format. | |
| paymentNumber | string | Receipt number. | |
| paymentStatus | string | The status of the payment, which will be one of the following:
Success
Voided
Declined
Error |
Example:
In the following example, the client set the void payment webhook URL to https://example.yourdomain.com/webhook/void. This POST request will send the payload to the specified URL.
Payload:
{
"orgGuid": "F9878BB3-4BDF-479F-8FCF-B075680A658A",
"statusDateTime": "2024-06-25 00:00:00",
"paymentNumber": "112233",
"paymentStatus": "Voided"
}
cURL:
curl -X POST ^
"https://example.yourdomain.com/webhook/void" ^
-H "Content-Type: application/json" ^
-d "{\"orgGuid\": \"F9878BB3-4BDF-479F-8FCF-B075680A658A\", \"statusDateTime\": \"2024-06-25 00:00:00\", \"paymentNumber\": \"112233\", \"paymentStatus\": \"Voided\"}"