API references

Topup settled

This event is triggered whenever a topup status transitioned to SUCCESSFUL.

Event signature
Event: topup_settled
POST <webhook_endpoint_destination_url> HTTP/1.1
Content-Type: application/json
Accept: application/json
Reservepay-Signature: <algorithm>=<signature>
{
event_id: string,
event: string,
topup_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 topup state change that occurred.

Possible values:
  • topup_settled
topup_id
string

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

status
string

Always present. Current status of the topup.

Possible values:
  • SUCCESSFUL
delivered_at
number

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