Payout events track the payment lifecycle for affiliate commissions.
Events
| Event | Description |
|---|
payout.created | New payout is created for an affiliate |
payout.updated | Payout is modified (universal event) |
payout.paid | Payout is marked as completed |
payout.failed | Payout fails |
payout.deleted | Payout is deleted |
Payout Status Values
| Status | Description |
|---|
PENDING | Payout created, awaiting processing |
PROCESSING | Payout is being processed |
COMPLETED | Payout successfully completed |
FAILED | Payout failed |
Payload
Event type (e.g., payout.paid)
ISO 8601 timestamp of when the event occurred
Event payload data.Show Data Object Properties
Unique identifier for the payout
The affiliate receiving this payout
The program this payout belongs to
Sequential invoice number for the payout
Payout status (see table above)
Whether this is an auto-managed payout
ISO 8601 timestamp when paid
Example Payloads
{
"id": "evt_abc123",
"type": "payout.created",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"payoutId": "pay_xyz789",
"affiliateId": "aff_abc123",
"affiliateProgramId": "prog_def456",
"invoiceNumber": 1042,
"amount": 250.00,
"status": "PENDING",
"isManagedPayout": false,
"paidAt": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}
}
{
"id": "evt_abc123",
"type": "payout.paid",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"payoutId": "pay_xyz789",
"affiliateId": "aff_abc123",
"affiliateProgramId": "prog_def456",
"invoiceNumber": 1042,
"amount": 250.00,
"status": "COMPLETED",
"isManagedPayout": true,
"paidAt": "2024-01-15T14:00:00.000Z",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:00:00.000Z"
}
}
{
"id": "evt_abc123",
"type": "payout.failed",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"payoutId": "pay_xyz789",
"affiliateId": "aff_abc123",
"affiliateProgramId": "prog_def456",
"invoiceNumber": 1042,
"amount": 250.00,
"status": "FAILED",
"isManagedPayout": true,
"paidAt": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:00:00.000Z"
}
}
