TriportRPC
DashboardDocs

GET /v1/referrals/payouts — List payout requests

GEThttps://api.triport.io/v1/referrals/payouts?limit=50&offset=0

Returns the authenticated user's referral payout requests, newest first, with pagination.

———

Lists the payout requests that the signed-in user has submitted against their referral balance. Each entry tracks a single withdrawal through its lifecycle — from the moment it is requested until it is sent on-chain (or fails / is cancelled).

This is a console (dashboard) endpoint, not a public RPC method. It is authenticated with the browser session cookie established at login — there is no API key or bearer token on this route. Use it to render a user's payout history table; create new payouts with POST /v1/referrals/payouts (see create-payout).

Results are returned as a flat list under items and are paginated with limit / offset. When the user has no payouts the endpoint returns {"items": []} (never null).

Parameters

Query parameters

limitintegeroptional
Maximum number of payouts to return. Range 1–200. Default 50.
offsetintegeroptional
Number of payouts to skip, for pagination. Default 0.

Response

Response fields

Each object in items is a Payout:

FieldTypeDescription
idstring (UUID)Unique payout request identifier.
user_idstring (UUID)Owner of the payout (the authenticated user).
amount_microintegerPayout amount in micro-units (1 unit = 1,000,000 micro).
networkstringDestination network for the withdrawal.
addressstringDestination address the funds are sent to.
statusstringLifecycle state. One of requested, processing, sent, failed, cancelled.
tx_hashstringOn-chain transaction hash. Present once sent; omitted otherwise.
notestringOptional operator note (e.g. failure reason). Omitted when empty.
requested_atstring (RFC 3339)When the payout was requested.
completed_atstring (RFC 3339)When the payout reached a terminal state (sent/failed/cancelled). Omitted while still pending.

status values

ValueMeaning
requestedSubmitted, awaiting processing.
processingBeing prepared / broadcast.
sentCompleted on-chain; tx_hash populated.
failedCould not be completed; see note.
cancelledVoided before completion.

Errors

CodeMeaningWhen it happens
401unauthenticatedNo valid console session cookie on the request.
500internalUnexpected server-side error while listing payouts.

See errors.md for the full error envelope shape.

Examples

JavaScript (fetch)

const res = await fetch(
  "https://api.triport.io/v1/referrals/payouts?limit=50&offset=0",
  {
    credentials: "include", // send the console session cookie
    headers: { "Content-Type": "application/json" },
  }
);
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const { items } = await res.json();
console.log(items);

TypeScript SDK (@triport/sdk)

import { TriportConsole } from "@triport/sdk";


const console_ = new TriportConsole(); // session-cookie auth
const { items } = await console_.referrals.listPayouts({
  limit: 50,
  offset: 0,
});

Python (triport-sdk)

from triport import ConsoleClient


console = ConsoleClient()  # session-cookie auth
resp = console.referrals.list_payouts(limit=50, offset=0)
for payout in resp["items"]:
    print(payout["id"], payout["status"], payout["amount_micro"])

Notes

  • Pagination: page through results by incrementing offset by limit. A returned page shorter than limit means you have reached the end. Values outside 1–200 for limit are clamped to that range; the default page size is 50.
  • Amounts: amount_micro is an integer in micro-units. Divide by 1_000_000 for the display value (e.g. 25000000 → 25.00).
  • Related: create a payout with POST /v1/referrals/payouts (create-payout); view the underlying balance and tier via GET /v1/referrals/me (overview).