Skip to main content
GET

Headers

string
required
Target API version (e.g. 1.2).

Response Body

array of objects
List of supported webhook event definitions available in the payout category.
number
Unique numeric identifier for the event definition (e.g. 13, 14, 15). Use these IDs when subscribing.
string
Human-readable label of the event (e.g. Batch submitted, Batch items paid successfully).
string
Dot-notated system code for the event (e.g. batch_payout.created, batch_payout.completed, batch_payout.partial).
string
Detailed summary describing the conditions under which this webhook event is triggered.
string
Event domain category (e.g. payout).
object
Template of the JSON payload dispatched to the partner webhook URL when this event occurs.
string
Event code matching the trigger.
object
Payload data object containing batchId, platformId, totalPayouts, and failedPayouts (if applicable).

Response Codes

Last modified on November 10, 2026