PaybytokenDocs
Tokens
API reference · Tokens

List Tokens

List the token and network combinations enabled for payments and payouts.

GET /api/v1/tokens

Overview

Retrieves enabled chain-and-currency combinations for the API key's test or live mode.

Authorization

  • Header: Authorization: Bearer $PAYBYTOKEN_SECRET_KEY
Request Details

Request

curl "https://api-prod.paybytoken.io/api/v1/tokens?chain=base&offset=0&limit=10" \
  -X GET \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"

Request Parameters

ParameterTypeDescription
chainstringFilter by exact chain code.
currencystringFilter by exact asset code.
offsetnumberStarting point for pagination.
limitnumberMaximum number of tokens to return per page.
Response Details

Response

The response returns a paginated list of Token objects containing details about supported tokens. See Tokens Overview for the full object definition.

Attributes

AttributeTypeDescription
totalintegerTotal enabled token/network combinations matching the filters.
dataarray of objectsToken configuration objects.

Example Response

{
  "total": 2,
  "data": [
    {
      "id": "tok_ofIgtXhdeH7wWHIW",
      "currency": "USDC",
      "chain": "ethereum",
      "decimals": 6,
      "name": "USD Coin",
      "chain_id": 11155111,
      "chain_name": "Ethereum",
      "currency_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/usdc-logo.png",
      "chain_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/eth-logo.png",
      "chain_explorer_url": "https://sepolia.etherscan.io",
      "contract_address": "0x1C0c0a3843f952DcD9159C9101f8E74844d92fED",
      "minimum_payment": "1.0",
      "minimum_payout": "1.0",
      "maximum_payment": "50000.0",
      "maximum_payout": "1000000.0",
      "enabled": 1,
      "created_at": "2025-09-25T17:13:50.000Z",
      "updated_at": "2025-09-25T17:13:50.000Z"
    },
    {
      "id": "tok_ofIiMC131ysXsbCj",
      "currency": "USDC",
      "chain": "base",
      "decimals": 6,
      "name": "USD Coin",
      "chain_id": 84532,
      "chain_name": "Base",
      "currency_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/usdc-logo.png",
      "chain_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/base-logo.png",
      "chain_explorer_url": "https://sepolia.basescan.org",
      "contract_address": "0xBd02F04420F7bA751d6240f053E2decfb6c90821",
      "minimum_payment": "0.1",
      "minimum_payout": "1.0",
      "maximum_payment": "50000.0",
      "maximum_payout": "1000000.0",
      "enabled": 1,
      "created_at": "2025-09-25T17:13:50.000Z",
      "updated_at": "2025-09-25T17:13:50.000Z"
    }
  ]
}

On this page

API Workbench

Full Explorer

Open in new tab