Skip to main content
Transaction events track sales and commission lifecycle.
transaction.created is emitted for both manual commission creation and automatic server-side conversion tracking via POST /conversions. If a conversion does not create an affiliate earning, the commission-related fields in the webhook payload can be null.

​
Events

EventDescription
transaction.createdNew transaction (sale) is recorded
transaction.updatedTransaction is modified (universal event)
transaction.approvedCommission is approved and ready for payment
transaction.paidCommission is paid to the affiliate
transaction.rejectedCommission is declined or refunded
transaction.deletedTransaction is deleted

​
Sale Status Values

StatusDescription
OPENTransaction pending payment
COMPLETEPayment successful
TRIALINGSubscription in trial period
FAILEDPayment failed
REFUNDEDFull refund processed
PARTIAL_REFUNDEDPartial refund processed

​
Commission Status Values

StatusDescription
PENDINGAwaiting hold period to expire
PENDING_MANUAL_APPROVALRequires manual approval
READY_FOR_PAYMENTApproved, included in next payout
PROCESSING_PAYOUTAssigned to an active payout
PAIDCommission has been paid
DECLINEDManually declined
REFUNDEDDeclined due to refund
DISPUTEUnder dispute investigation

​
Payload

​
id
string
Unique event identifier
​
type
string
Event type (e.g., transaction.created)
​
createdAt
string
ISO 8601 timestamp of when the event occurred
​
data
object
Event payload data.

​
Example Payloads

transaction.created
{
  "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"
  }
}
transaction.approved
{
  "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"
  }
}
transaction.paid
{
  "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"
  }
}
transaction.rejected
{
  "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"
  }
}