API Reference

Wallets

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Get payment configurations

gethttps://api.circle.com/v1/cpn/configurations/overview

Reference
Playground

Returns the overview of supported countries, currencies, payment methods, blockchains.

Response

200PaymentConfigurationOverviewResponse

Response Body

object

data

object

Required

Overview of available payment configurations including supported blockchains, countries, currencies, and payment methods.

Show 5 properties

destinationCountries

array of strings

List of supported countries where payments can be received.

Allowed valuesATBEBGBRCHCYCZDEDKEEESFIFRGBGRHKHRHUIEITLILTLUMTMXNGNLNOPLPTROSESISKUS

destinationCurrencies

array of strings

List of supported fiat currencies.

Allowed valuesBRLEURGBPHKDMXNNGNUSD

paymentMethodTypes

array of strings

List of supported payment methods.

Allowed valuesPIXSPEIWIREFPSCHATSBANK-TRANSFERSEPA

sourceCurrencies

array of strings

List of supported source cryptocurrencies.

Allowed valuesUSDC

blockchains

array of strings

List of supported blockchains.

Allowed valuesSOLMATICETHSOL-DEVNETMATIC-AMOYETH-SEPOLIA

401NotAuthorizedResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

403ForbiddenResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "destinationCountries": [
4      "MX"
5    ],
6    "destinationCurrencies": [
7      "MXN"
8    ],
9    "paymentMethodTypes": [
10      "SPEI"
11    ],
12    "sourceCurrencies": [
13      "USDC"
14    ],
15    "blockchains": [
16      "ETH-SEPOLIA"
17    ]
18  }
19}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy