You can use the API to discover which corridors, currencies, and payment methods are available. Retrieving this information and handling it in your integration allows you to show your users the available sources and destinations for funds in CPN.
Use the following steps to request CPN configuration overview, and get the available routes from country to country.
Make a request to the configurations overview endpoint to receive a list of supported currencies, countries, payment methods, and blockchains.
curl -H "Authorization: Bearer ${YOUR_API_KEY}" \
-X GET https://api.circle.com/v1/cpn/v1/ofi/configurations/overview
Response
{
"data": {
"sourceCurrencies": ["USDC"],
"destinationCountries": ["BR", "HK", "MX", "NG", "US"],
"destinationCurrencies": ["BRL", "HKD", "MXN", "NGN", "USD"],
"paymentMethodTypes": [
"ACH-BANK-TRANSFER",
"BANK-TRANSFER",
"CHATS",
"FPS",
"PIX",
"SPEI",
"WIRE"
],
"blockchains": ["ETH-SEPOLIA", "MATIC-AMOY", "SOL-DEVNET"]
}
}
Evaluate the available route details for a specific transfer by making a request to the supported payment routes endpoint. This example evaluates a route from the US to Mexico, but other routes can be evaluated by changing the query parameters.
curl -H "Authorization: Bearer ${YOUR_API_KEY}" \
-X GET https://api.circle.com/v1/cpn/v1/ofi/configurations/routes?sourceCurrency=USDC&destinationCountry=MX
Response
{
"data": [
{
"destinationCurrency": "MXN",
"paymentMethodType": "SPEI",
"blockchain": "ETH-SEPOLIA",
"fiatLimit": {
"min": "168",
"max": "837500",
"currency": "MXN"
},
"cryptoLimit": {
"min": "8.34",
"max": "41552.14",
"currency": "USDC"
}
}
]
}