API Reference

Create a quote

posthttps://api.circle.com/v1/cpn/quotes

Reference
Playground

Creates one or more quotes for the given source/destination parameters. Returns quotes sorted in the following order:

Ascending of sourceAmount if your quote is based on destinationAmount.
Descending of destinationAmount if your quote is based on sourceAmount.

Body parameters

recipientType

string

Required

Type of entity sending or receiving the payment

Allowed valuesBUSINESSINDIVIDUAL

senderType

string

Required

Type of entity sending or receiving the payment

Allowed valuesBUSINESSINDIVIDUAL

blockchain

string

Required

Supported blockchain networks

Allowed valuesSOLMATICETHSOL-DEVNETMATIC-AMOYETH-SEPOLIA

destinationAmount

object

Required

The amount of fiat currency to be delivered to the destination. This field is an object containing the currency code and the amount. This field is required; however, if your query is based on the sourceAmount, leave the amount field blank and only populate the currency field.

Show 2 properties

amount

string

currency

string

Supported fiat currencies

Allowed valuesBRLEURGBPHKDMXNNGNUSD

destinationCountry

string

Required

ISO 3166-1 alpha-2 two-letter country code supported by the Circle Payment Network

Allowed valuesATBEBGBRCHCYCZDEDKEEESFIFRGBGRHKHRHUIEITLILTLUMTMXNGNLNOPLPTROSESISKUS

sourceAmount

object

Required

The amount of fiat currency to be delivered to the destination. This field is an object containing the currency code and the amount. This field is required; however, if your query is based on the destinationAmount, leave the amount field blank and only populate the currency field.

Show 2 properties

amount

string

currency

string

Supported cryptocurrencies

Allowed valuesUSDC

senderCountry

string

Required

ISO 3166-1 alpha-2 two-letter country code supported by the Circle Payment Network

Allowed valuesATBEBGBRCHCYCZDEDKEEESFIFRGBGRHKHRHUIEITLILTLUMTMXNGNLNOPLPTROSESISKUS

paymentMethodType

string

The method used for the payment (e.g., PIX, WIRE, ACH)

Allowed valuesPIXSPEIWIREFPSCHATSBANK-TRANSFERSEPA

Response

201QuotesResponse

Response Body

object

data

array of objects

Required

Array of quotes containing all the necessary information for payments

Show 16 properties

string

System-generated unique identifier of the resource.

paymentMethodType

string

The method used for the payment (e.g., PIX, WIRE, ACH)

Allowed valuesPIXSPEIWIREFPSCHATSBANK-TRANSFERSEPA

blockchain

string

Supported blockchain networks

Allowed valuesSOLMATICETHSOL-DEVNETMATIC-AMOYETH-SEPOLIA

senderCountry

string

ISO 3166-1 alpha-2 two-letter country code supported by the Circle Payment Network

Allowed valuesATBEBGBRCHCYCZDEDKEEESFIFRGBGRHKHRHUIEITLILTLUMTMXNGNLNOPLPTROSESISKUS

destinationCountry

string

ISO 3166-1 alpha-2 two-letter country code supported by the Circle Payment Network

Allowed valuesATBEBGBRCHCYCZDEDKEEESFIFRGBGRHKHRHUIEITLILTLUMTMXNGNLNOPLPTROSESISKUS

createDate

string

Date and time when the resource was created

quoteExpireDate

string

Date and time when the resource expires

cryptoFundsSettlementExpireDate

string

Date and time when the resource expires

sourceAmount

object

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show 2 properties

amount

string

currency

string

Supported cryptocurrencies

Allowed valuesUSDC

destinationAmount

object

Represents an amount of money in a specific fiat currency, including both the numerical amount and the currency type.

Show 2 properties

amount

string

currency

string

Supported fiat currencies

Allowed valuesBRLEURGBPHKDMXNNGNUSD

fiatSettlementTime

object

Estimated time range for when funds will arrive at their destination after a transfer is initiated. The time varies depending on the fiat payment method used (e.g., ACH, SEPA, Wire). The time is represented as a range with minimum and maximum values in the specified unit.

Show 3 properties

max

string

min

string

unit

string

Allowed valuesMINUTESHOURSDAYSWEEKS

exchangeRate

object

Show 2 properties

pair

string

The currency pair in format cryptoCurrency/localFiatCurrency

rate

string

The exchange rate between source and destination currencies

fees

object

A collection of fees associated with a payment transaction, including both individual fee breakdowns and the total amount.

Show 2 properties

breakdown

array of objects

Detailed breakdown of individual fees that make up the total payment fees.

Show 2 properties

amount

object

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show 2 properties

amount

string

currency

string

Supported cryptocurrencies

Allowed valuesUSDC

type

string

The type of fee being charged for the transaction.

Allowed valuesTAX_FEEBFI_TRANSACTION_FEE

totalAmount

object

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show 2 properties

amount

string

currency

string

Supported cryptocurrencies

Allowed valuesUSDC

senderType

string

Type of entity sending or receiving the payment

Allowed valuesBUSINESSINDIVIDUAL

recipientType

string

Type of entity sending or receiving the payment

Allowed valuesBUSINESSINDIVIDUAL

certificate

object

Show 4 properties

string

System-generated unique identifier of the resource.

certPem

string

Base64 encoded certificate in PEM format

domain

string

BFI domain which is available in the CommonName attribute of the cert

jwk

object

The public key for the BFI defined in RFC 7517

Show 5 properties

crv

string

The curve used for the EC key

kid

string

Key ID

kty

string

Key type

string

X coordinate for the EC public key

string

Y coordinate for the EC public key

400BadRequestResponse

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

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    {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "paymentMethodType": "SPEI",
6      "blockchain": "ETH-SEPOLIA",
7      "senderCountry": "MX",
8      "destinationCountry": "MX",
9      "createDate": "2023-01-01T12:04:05Z",
10      "quoteExpireDate": "2023-01-01T12:04:05Z",
11      "cryptoFundsSettlementExpireDate": "2023-01-01T12:04:05Z",
12      "sourceAmount": {
13        "amount": "110.27",
14        "currency": "USDC"
15      },
16      "destinationAmount": {
17        "amount": "11000.27",
18        "currency": "MXN"
19      },
20      "fiatSettlementTime": {
21        "max": "3",
22        "min": "1",
23        "unit": "DAYS"
24      },
25      "exchangeRate": {
26        "pair": "USDC/MXN",
27        "rate": "1.2345"
28      },
29      "fees": {
30        "breakdown": [
31          {
32            "amount": {
33              "amount": "110.27",
34              "currency": "USDC"
35            },
36            "type": "BFI_TRANSACTION_FEE"
37          }
38        ],
39        "totalAmount": {
40          "amount": "110.27",
41          "currency": "USDC"
42        }
43      },
44      "senderType": "BUSINESS",
45      "recipientType": "BUSINESS",
46      "certificate": {
47        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
48        "certPem": "LS0tLS1CRUdJT...",
49        "domain": "api.circle.com",
50        "jwk": {
51          "crv": "P-256",
52          "kid": "263521881931753643998528753619816524468853605762",
53          "kty": "EC",
54          "x": "KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE",
55          "y": "D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"
56        }
57      }
58    }
59  ]
60}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy