Console API — Referrals
Referral program endpoints: codes, invitees, rewards, payouts and the admin operations behind the affiliate cabinet.
- Method / Endpoint
https://triport.io/v1/referrals/…- Network
- — (account-level)
- Authentication
- Console session — see session model
- Tier / rate limit
- Account-level; not metered against chain RPS budgets
What this section covers
The affiliate cabinet as an API: read or set a referral code, list invitees and the rewards they generated, request a payout and follow its status, apply referral credit to an invoice. Admin-scoped endpoints let operators review and execute payouts.
The endpoint list is below; every page carries the request/response schema, error envelope and a runnable example. Part of the Console API.
DELETE DELETE /v1/referrals/code — Remove custom referral slug
Disables your active custom referral slug; your permanent UID-based code keeps working.
GET GET /v1/referrals/invitees — List referred users
Returns the users who signed up under your referral code, with how much each has paid.
GET GET /v1/referrals/me — Referral overview
Returns the authenticated user's referral overview: their primary code, tier, commission rate, paid-invitee count, and earnings balance.
GET GET /v1/referrals/payouts — List payout requests
Returns the authenticated user's referral payout requests, newest first, with pagination.
GET GET /v1/referrals/rewards — List referral rewards
Lists the calling user's referral rewards — one row per qualifying payment event — with optional status filtering and pagination.
POST POST /v1/auth/attribute — Attribute signup to a referral code
Best-effort post-login hook that links a freshly signed-in account to the referral code captured in the visitor's ref_code cookie.
POST POST /v1/referrals/code — Set custom referral slug
Create or update the authenticated user's custom referral code (slug).
POST POST /v1/referrals/payouts — Request a referral payout
Submits a request to pay out your available referral balance to an on-chain address; the request is created in requested status and settled asynchronously by operators.
POST POST /v1/referrals/spend-on-invoice — Apply referral credit to an invoice
Spends part of your available referral balance to cover an eligible invoice in full.