Available tokens (payor)

Overview

Use this method to list tokens the payor can use for the current invoice/session context.

Authentication

Requires x-session-token + x-signature.

Request

List available tokens (payor/session)

const tokens = await pepay.paymentSessions.listAvailableTokens({
  mode: 'monitored',
  network: 'base',
  available_only: true
});

Response

Example response (truncated):

[
  {
    "id": 123,
    "token_symbol": "USDC",
    "token_name": "USD Coin",
    "token_type": "erc20",
    "network": "base",
    "token_decimals": 6,
    "token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "requires_memo": false,
    "photo_uri": "https://assets.coingecko.com/coins/images/6319/small/USD_Coin_icon.png"
  }
]

Underpaid behavior

If the invoice is underpaid, this endpoint returns only the locked token for the original network.

Availability filtering

Use available_only: true to return only tokens that are currently available for the invoice amount. Otherwise, the response includes unavailable tokens with availability_status and unavailable_reason populated.

Errors

401 invalid session token/signature

Examples

Use network + mode filters to keep the list aligned to your checkout UI and the invoice’s active network.

Next: Payment status

Getting Started

Merchants

Commerce

Payors

Available tokens (payor)

Overview

Authentication

Request

List available tokens (payor/session)

Response

Underpaid behavior

Availability filtering

Errors

Examples

​Overview

​Authentication

​Request

​List available tokens (payor/session)

​Response

​Underpaid behavior

​Availability filtering

​Errors

​Examples

Overview

Authentication

Request

List available tokens (payor/session)

Response

Underpaid behavior

Availability filtering

Errors

Examples