API references
Search documentation... ⌘K
API references
Open merchant dashboard
Events
All our references
<h2>Payout completed</h2> <p>This event is triggered whenever a payout status transitioned to either <code>SUCCESSFUL</code> or <code>FAILED</code>.</p>
Event signature
Event: payout_completed
POST <webhook_endpoint_destination_url> HTTP/1.1
Content-Type: application/json
Accept: application/json
X-Webhook-Signature: <signature>
{
event_id: string,
event: string,
payout_id: string,
status: string,
}
Attributes
Attribute Description
event_id
string

The unique identifier for the event
event
string

The event name that triggered the webhook. Indicates the type of payout state change that occurred.

Possible values:
  • payout_completed
payout_id
string

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

Current status of the payout.

Possible values:
  • SUCCESSFUL
  • FAILED