ReferenceOverview

API Reference

Comprehensive reference documentation for all T402 packages. For protocol concepts, see Core Concepts.

Facilitator API

Mechanisms

Extensions

Middleware & Clients

UI Components

AI & Agents

Wallet & CLI

Common Types

PaymentRequirements

interface PaymentRequirements {
  scheme: string;           // Payment scheme (e.g., "exact")
  network: string;          // CAIP-2 network ID (e.g., "eip155:8453")
  amount: string;           // Amount in smallest units (e.g., "1000000" for 1 USDT)
  payTo: string;            // Recipient address
  asset?: string;           // Token address (optional, defaults to native USDT)
  maxTimeoutSeconds?: number;
  extra?: Record<string, unknown>;
}

PaymentPayload

interface PaymentPayload {
  t402Version: number;      // Protocol version (2)
  accepted: {
    scheme: string;
    network: string;
    amount: string;
    payTo: string;
    asset?: string;
    extra?: Record<string, unknown>;
  };
  payload: Record<string, unknown>; // Scheme-specific payload
}

Error Codes

CodeDescription
INSUFFICIENT_BALANCENot enough tokens for payment
INVALID_SIGNATUREPayment signature verification failed
EXPIRED_PAYMENTPayment authorization has expired
NETWORK_MISMATCHWrong blockchain network
INVALID_RECIPIENTInvalid payment recipient address