API references
Search documentation... ⌘K
Open merchant dashboard
Webhook events
All our references

Payout completed

This event is triggered whenever a payout status transitioned to either SUCCESSFUL or FAILED.

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

Possible values:
  • payout_completed
payout_id
string

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

Nullable. The external ID of the payout.
status
string

Always present. Current status of the payout.

Possible values:
  • SUCCESSFUL
  • FAILED
delivered_at
number

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