Skip to main content

Tokens Overview

Description

The Tokens API group allows users to manage and retrieve information about supported cryptocurrency tokens across various blockchain networks. This resource is essential for integrating token-specific details, such as currency, chain, and transaction limits, into payment and payout workflows, ensuring compatibility and compliance with network standards.

API Endpoints

  • Get Token: Retrieves the details of a specific token by its ID.
  • List Tokens: Returns a paginated list of all supported tokens with optional filtering.

API Endpoint Reference

MethodEndpointDescription
GET/v1/tokens/:idRetrieves the details of a specific token.
GET/v1/tokensLists all supported tokens with filters.

Attributes

AttributeTypeDescription
idstringUnique identifier for the token (e.g., tok_123456789).
currencystringCurrency code of the token (e.g., USDC).
chainstringBlockchain network (e.g., base).
decimalsnumberNumber of decimal places for the token.
namestringOptional human-readable name of the token (e.g., USD Coin).
chain_idnumberOptional chain ID (e.g., 8453).
chain_namestringOptional full name of the blockchain (e.g., Base).
currency_logo_urlstringOptional URL to the token's logo.
chain_logo_urlstringOptional URL to the chain's logo.
chain_explorer_urlstringOptional URL to the blockchain explorer.
contract_addressstringOptional smart contract address (e.g., 0x...).
minimum_paymentstringMinimum payment amount.
minimum_payoutstringMinimum payout amount.
maximum_paymentstringMaximum payment amount.
maximum_payoutstringMaximum payout amount.
enabledbooleanIndicates if the token is enabled.
created_atstringCreation timestamp.
updated_atstringLast update timestamp.