Referral program results and settings.
List affiliates
Users who referred at least one sign-up, ranked by commission earned, then by referrals.
query Parameters
limitPage size (clamped to 1-200).
offsetRows to skip.
List affiliates › Responses
A page of affiliates with program totals.
totalUsers with at least one referral.
total_commission_nanoAll commission ever paid, nano-USD.
total_bonus_nanoAll referee bonuses ever paid, nano-USD.
Get affiliate settings
The affiliate program terms.
Get affiliate settings › Responses
Affiliate settings.
enabledcommission_percentShare of each paid top-up of a referred user credited to the referrer.
commission_monthsCommission is paid on top-ups within this many months of the referral.
referee_bonus_percentExtra credit for the referred user on their first paid top-up.
Update affiliate settings
Replaces the program terms. Omitted fields take their defaults (enabled: false, 10 %,
12 months, 10 %), so send all four. Percentages are rounded to two decimals.
Update affiliate settings › Request Body
enabledcommission_percentShare of each paid top-up of a referred user credited to the referrer.
commission_monthsCommission is paid on top-ups within this many months of the referral.
referee_bonus_percentExtra credit for the referred user on their first paid top-up.
Update affiliate settings › Responses
The saved settings.
enabledcommission_percentShare of each paid top-up of a referred user credited to the referrer.
commission_monthsCommission is paid on top-ups within this many months of the referral.
referee_bonus_percentExtra credit for the referred user on their first paid top-up.