API references

Payment voided

This event is triggered whenever a payment status transitioned to VOIDED.

Event signature
Event: payment_voided
POST <webhook_endpoint_destination_url> HTTP/1.1
Content-Type: application/json
Accept: application/json
Reservepay-Signature: <algorithm>=<signature>
{
event_id: string,
event: string,
payment_id: string,
external_id: string?,
status: string,
delivered_at: number,
}
New to Reservepay? Read our guide on how to work with webhook events to get started.
Event attributes
Attribute Description
event_id
string

Always present. The unique identifier for the event

event
string

Always present. The event name that triggered the webhook. Indicates the type of payment state change that occurred.

Possible values:
  • payment_voided
payment_id
string

Always present. Unique identifier for the payment. This is the payment's UID that can be used to reference the payment in API calls.

external_id
string

Nullable. The external ID of the payment.

status
string

Always present. Current status of the payment.

Possible values:
  • VOIDED
delivered_at
number

Always present. Unix timestamp indicating when the event was delivered to the webhook endpoint.