Skip to main content

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

NameTypeDescription
orgGuid stringOrganization's unique identifier.
statusDateTime stringVoid payment date and time (UTC).
paymentNumber stringReceipt number.
paymentStatus stringThe status of the payment.

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 data to that specified URL.

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\"}"

Payload:

{
"orgGuid": "F9878BB3-4BDF-479F-8FCF-B075680A658A",
"statusDateTime": "2024-06-25 00:00:00",
"paymentNumber": "112233",
"paymentStatus": "Voided"
}