Get supported payment routes
Returns a list of route details including trade limits. This information can determine what corridors and parameters are valid for subsequent quote creation.
Authorizations
Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.
Query Parameters
Filter by the source currency, should be the crypto token Supported cryptocurrencies
EURC, USDC "USDC"
Filter by destination country
ISO 3166-1 alpha-2 two-letter country code. The set of countries the Circle Payment Network serves changes as corridors launch; call GET /v1/cpn/configurations/enabledRoutes for the live list.
"MX"
The version of the transaction. If not provided, defaults to VERSION_1.
VERSION_1, VERSION_2 "VERSION_2"
Filter by destination currency, will return all available destination currencies if empty
Currently supported fiat currency (ISO 4217 code). This set changes as corridors launch; call GET /v1/cpn/configurations/enabledRoutes for the live list.
"MXN"
Filter by payment method, will return all available payment method types if empty The method used for the payment (e.g., PIX, WIRE, CHATS)
AANI, ACH-BANK-TRANSFER, BANK-TRANSFER, CHATS, CIPS, FAST, FEDWIRE, FPS, FTS, IMPS, INSTAPAY, NEFT, NEQUI, PESONET, PIX, RTGS, SD-ACH, SEPA, SPEI, SPID, WIRE "SPEI"
Filter by blockchain, will return all available blockchains if empty Supported blockchain networks
SOL, MATIC, ETH, ARC, SOL-DEVNET, MATIC-AMOY, ETH-SEPOLIA, ARC-TESTNET "ETH-SEPOLIA"
Filter by use case, will return all available useCases if empty The type of payment use case
B2B, B2C, C2C, C2B "B2B"
Response
payment routes retrieved successfully.
Array of payment routes containing all the necessary information for routing payments