Transaction events track sales and commission lifecycle.
Events
| Event | Description |
|---|
transaction.created | New transaction (sale) is recorded |
transaction.updated | Transaction is modified (universal event) |
transaction.approved | Commission is approved and ready for payment |
transaction.paid | Commission is paid to the affiliate |
transaction.rejected | Commission is declined or refunded |
transaction.deleted | Transaction is deleted |
Sale Status Values
| Status | Description |
|---|
OPEN | Transaction pending payment |
COMPLETE | Payment successful |
TRIALING | Subscription in trial period |
FAILED | Payment failed |
REFUNDED | Full refund processed |
PARTIAL_REFUNDED | Partial refund processed |
Commission Status Values
| Status | Description |
|---|
PENDING | Awaiting hold period to expire |
PENDING_MANUAL_APPROVAL | Requires manual approval |
READY_FOR_PAYMENT | Approved, included in next payout |
PROCESSING_PAYOUT | Assigned to an active payout |
PAID | Commission has been paid |
DECLINED | Manually declined |
REFUNDED | Declined due to refund |
DISPUTE | Under dispute investigation |
Payload
Event type (e.g., transaction.created)
ISO 8601 timestamp of when the event occurred
Event payload data.Show Data Object Properties
Unique identifier for the transaction
The referral this transaction belongs to
The affiliate who earned this commission
The sale amount (in program currency)
Currency code (e.g., USD)
Transaction status (see table above)
Commission status (see table above)
Type: COMMISSION or BONUS
Days commission was held before approval
Associated payout invoice ID
Example Payloads
{
"id": "evt_abc123",
"type": "transaction.created",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"transactionId": "txn_xyz789",
"referralId": "ref_abc123",
"affiliateId": "aff_def456",
"saleAmount": 99.00,
"saleCurrency": "USD",
"saleStatus": "COMPLETE",
"commissionAmount": 29.70,
"commissionCurrency": "USD",
"commissionStatus": "PENDING",
"incentiveType": "COMMISSION",
"holdPeriodDays": 30,
"invoiceId": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z"
}
}
{
"id": "evt_abc123",
"type": "transaction.approved",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"transactionId": "txn_xyz789",
"referralId": "ref_abc123",
"affiliateId": "aff_def456",
"saleAmount": 99.00,
"saleCurrency": "USD",
"saleStatus": "COMPLETE",
"commissionAmount": 29.70,
"commissionCurrency": "USD",
"commissionStatus": "READY_FOR_PAYMENT",
"incentiveType": "COMMISSION",
"holdPeriodDays": 30,
"invoiceId": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-02-14T10:30:00.000Z"
}
}
{
"id": "evt_abc123",
"type": "transaction.paid",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"transactionId": "txn_xyz789",
"referralId": "ref_abc123",
"affiliateId": "aff_def456",
"saleAmount": 99.00,
"saleCurrency": "USD",
"saleStatus": "COMPLETE",
"commissionAmount": 29.70,
"commissionCurrency": "USD",
"commissionStatus": "PAID",
"incentiveType": "COMMISSION",
"holdPeriodDays": 30,
"invoiceId": "inv_123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-02-28T10:30:00.000Z"
}
}
{
"id": "evt_abc123",
"type": "transaction.rejected",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"transactionId": "txn_xyz789",
"referralId": "ref_abc123",
"affiliateId": "aff_def456",
"saleAmount": 0,
"saleCurrency": "USD",
"saleStatus": "REFUNDED",
"commissionAmount": 0,
"commissionCurrency": "USD",
"commissionStatus": "REFUNDED",
"incentiveType": "COMMISSION",
"holdPeriodDays": null,
"invoiceId": null,
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-20T14:00:00.000Z"
}
}
