Console API

The API behind the Triport dashboard — sign-in and sessions, API-key management, billing and invoices, and the referral program — for automating anything you can do in the console UI.


Method / Endpoint	`https://triport.io/v1/…` (per endpoint)
Network	— (account-level)
Authentication	Console session / account credentials — see session model
Required scope	—
Tier / rate limit	Account-level; not metered against chain RPS budgets

What this surface is

Everything the Triport console does goes through this API, so you can script it: create and rotate keys from CI, pull invoices into accounting, or wire referral stats into your own dashboards. It is account-level — distinct from the chain data planes (/sol, /eth, /polygon), which use API keys.

Endpoint groups

Auth — email and wallet sign-in flows, sessions, session model, me.
Keys — create, list, rotate, revoke; per-key endpoints and usage.
Billing — balance, invoices, in-app transactions, rails, event streams.
Referrals — codes, invitees, rewards, payouts, and admin operations.

The full endpoint list is below.

Auth 10

GET GET /v1/auth/google/callback

Browser-facing OAuth callback that completes the Google sign-in dance, issues a console session, and redirects into the app.

GET GET /v1/auth/google/start

Begins the Google OAuth sign-in flow by redirecting the browser to Google's consent screen.

GET GET /v1/auth/me

Returns the currently authenticated console user, their primary sign-in provider, and their default API key — bootstrapping that key on first login.

POST POST /v1/auth/attribute

Attributes the freshly-signed-in console user to the referrer recorded in their ref_code cookie — best-effort, always returns 200.

POST POST /v1/auth/email/start

Begins email one-time-password (OTP) login by sending a 6-digit code to the supplied address and returning a request_id to use in the verify step.

POST POST /v1/auth/email/verify

Completes the email one-time-passcode (OTP) login flow: verifies the code, opens an authenticated console session, and returns the signed-in user.

POST POST /v1/auth/logout

Revokes the current console session and clears the nl_session cookie.

POST POST /v1/auth/wallet/challenge

Start a wallet sign-in by requesting a single-use nonce and a human-readable message for the wallet to sign.

POST POST /v1/auth/wallet/verify

Verify a wallet signature against a previously issued challenge nonce, then open an authenticated console session.

Session and CSRF model

How the Triport console authenticates browser requests: an opaque

Billing 12

GET Balance SSE event stream

A Server-Sent Events stream that pushes your account's authoritative balance on connect and on every credit or debit.

POST Build in-app transaction

Build the unsigned Solana transaction that settles an in-app invoice, ready for the customer's wallet to sign and submit.

POST Cancel an invoice

Cancels one of your own pending invoices, transitioning it from pending to cancelled.

POST Create an invoice

Open a single-rail payment invoice for the signed-in console user — one invoice maps to exactly one channel, one rail, and one deposit address.

GET Get balance

Returns the authenticated user's current account balance, in micro-USD, along with its lock state.

GET Get invoice

Fetch a single invoice you own, including its payment address, QR payment URI, and how much has been received so far.

GET Invoice SSE event stream

Subscribe to live state changes for a single invoice over Server-Sent Events (SSE) — from the moment it is created until it is paid, cancelled, or expires.

GET List balance ledger entries

Returns a cursor-paginated, newest-first slice of your account's balance ledger (every credit and debit).

GET List invoices

Return the authenticated user's billing invoices, optionally filtered by status and capped to a limit.

GET List payment rails

Returns the catalog of payment rails (network + token combinations) the platform can accept, so the frontend can build its payment channel/rail selector.

POST Pay invoice from balance

Settle a pending invoice instantly by debiting the signed-in user's prepaid balance.

POST Submit in-app transaction

Notify the billing backend that a signed Solana payment transaction for an in-app invoice has been (or should be) broadcast.

API Keys 6

POST Create an API key

Mint a new API key for your account and receive its secret value — returned exactly once, at creation time.

GET Get key endpoints

Return the per-chain connection endpoints a given API key can use, as a URL template the caller fills in client-side with the raw key.

GET Get usage metrics

Returns aggregated request usage for the signed-in account over a time range, broken down by RPC method or by chain.

GET List API keys

Return every API key on the authenticated account, including its public prefix, scopes, and status — but never the raw secret.

DELETE Revoke an API key

Permanently disables one of your API keys so it can no longer authenticate requests.

POST Rotate an API key

Atomically revokes an existing key and issues a replacement that inherits its name, scopes, rate limit, and default flag — returning the new raw secret exactly once.

Referrals 14

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/admin/referrals/users/{user_id} — Operator view of a user

Operator-only lookup that returns a single user's full referral state — tier, code, paid-invitee count, balance, and their most recent attribution audit rows — in one call.

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/admin/referrals/payouts/{id}/failed — Mark payout as failed

Operator action that transitions a referral payout into the terminal failed state, optionally recording a reason.

POST POST /v1/admin/referrals/payouts/{id}/sent — Mark payout as sent

Operator action that marks a referral payout as sent, recording the on-chain transaction hash that fulfilled it.

POST POST /v1/admin/referrals/simulate-paid — (Retired) Simulate paid invoice

Retired endpoint. This operator route is no longer offered — it always responds 410 Gone. It existed only in stage 1, before the automated billing bridge began emitting referral rewards from real invoice_paid events. The intended contract is documented below for historical reference.

POST POST /v1/admin/referrals/users/{user_id}/tier — Override user referral tier

Operator action that sets a user's referral tier directly; the platform never auto-promotes, so this endpoint is the only way a tier changes.

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.