Transaction Events

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. Refunds triggered through the Refund Conversion endpoint emit transaction.updated for partial refunds and transaction.rejected for full refunds. If a conversion does not create an affiliate earning, the commission-related fields in the webhook payload can be null.

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

string

Unique event identifier

string

Event type (e.g., transaction.created)

string

ISO 8601 timestamp of when the event occurred

object

Event payload data.

Show Data Object Properties

string

Unique identifier for the transaction

string

The referral this transaction belongs to

string

The affiliate who earned this commission

number

The sale amount (in program currency)

string

Currency code (e.g., USD)

string

Transaction status (see table above)

number

Commission amount earned

string

Commission currency code

string

Commission status (see table above)

string

Type: COMMISSION or BONUS

number | null

Days commission was held before approval

string | null

Associated payout invoice ID

string

ISO 8601 timestamp

string

ISO 8601 timestamp

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"
  }
}

Overview

Events

Usage & Examples

Automation Tools

Events

Sale Status Values

Commission Status Values

Payload

Example Payloads

​Events

​Sale Status Values

​Commission Status Values

​Payload

​Example Payloads

Events

Sale Status Values

Commission Status Values

Payload

Example Payloads