Track transactions from referred customers in refer-a-friend programs
customer (referring customer) and referred_customer instead of partner and customer used in affiliate programs.| Parameter | Type | Required | Description |
|---|---|---|---|
key | string | No | Unique transaction ID (recommended for refund handling) |
amount | number | Yes | Transaction amount |
amount_units | string | No | Currency code (e.g., USD, EUR) |
action | string | No | Transaction type (e.g., sale) |
customer.id | string | Yes* | Referred customer’s ID |
customer.email | string | Yes* | Referred customer’s email (alternative to ID) |
customer.key | string | Yes* | Referred customer’s key (alternative to ID) |
| Field | Type | Description |
|---|---|---|
key | string | Transaction identifier |
action | string | Transaction type |
amount | number | Transaction amount |
amount_units | string | Currency code |
customer | string | Referring customer’s identifier |
referred_customer | string | Referred customer’s identifier |
credit | boolean | Whether this is a credit transaction |
is_currency | boolean | Whether the amount is monetary |
rewards | array | Associated rewards |
created_at | string | ISO 8601 timestamp |
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 15 | Results per page (1–250) |
page | integer | 1 | Page number |