AffiLink

Read earnings

Use this to report what a role has earned. Wallet balance and commission totals are different numbers.

Role

Every role can read its wallet. Content earnings follow that role’s content list. Affilink earnings are on the influencer path. Conversions are on the client path only.

Requests

  1. GET /api/v1/affilink/{role}/wallet. INR is the account wallet total, including child wallets. Other rows, such as XP, are that role’s sub-account holdings.
  2. GET /api/v1/affilink/{role}/contents and, for an influencer, GET /api/v1/affilink/influencer/affilinks. Read realised_earnings, unrealised_earnings, and lost_earnings on each row.
  3. Client only: GET /api/v1/affilink/client/conversions and GET /api/v1/affilink/client/conversions/{id}. Optional status is pending, success, or failed.

Keep

Keep each balance’s currency and balance. Keep the three earnings fields separate from the wallet. On a conversion, keep id, status, identifier, product_event_name, value, and product_id. value is null when the event has no value. There is no customer contact data.

Stop

Do not top up a wallet, request a payout, or read an invoice. There is no ledger on this route. Do not add the earnings fields into the wallet balance. Conversion fields are on the AffiLink API page.