Get details of a quote

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Path Parameters

quoteId

string<uuid>

required

The quote id that was created previously. System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

Response

The quote retrieved successfully.

data

object

required

A quote containing all the necessary information for a cryptocurrency payment transaction, including source and destination amounts, fees, exchange rates, and relevant timing information.

Show child attributes

data.id

string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.paymentMethodType

enum<string>

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

Available options:

AANI,

BANK-TRANSFER,

CHATS,

CIPS,

FAST,

FPS,

FTS,

IMPS,

INSTA-PAY,

NEFT,

NEQUI,

PESONET,

PIX,

RTGS,

SEPA,

SPEI,

WIRE

Example:

"SPEI"

data.blockchain

enum<string>

Supported blockchain networks

Available options:

SOL,

MATIC,

ETH,

SOL-DEVNET,

MATIC-AMOY,

ETH-SEPOLIA

Example:

"ETH-SEPOLIA"

data.senderCountry

enum<string>

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

Available options:

AT,

BE,

BG,

BR,

CH,

CN,

CO,

CY,

CZ,

DE,

DK,

EE,

ES,

FI,

FR,

GB,

GR,

HK,

HR,

HU,

IE,

IN,

IT,

LI,

LT,

LU,

MT,

MX,

NG,

NL,

NO,

PL,

PT,

RO,

SE,

SI,

SK,

US

Example:

"MX"

data.destinationCountry

enum<string>

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

Available options:

AT,

BE,

BG,

BR,

CH,

CN,

CO,

CY,

CZ,

DE,

DK,

EE,

ES,

FI,

FR,

GB,

GR,

HK,

HR,

HU,

IE,

IN,

IT,

LI,

LT,

LU,

MT,

MX,

NG,

NL,

NO,

PL,

PT,

RO,

SE,

SI,

SK,

US

Example:

"MX"

data.createDate

string<date-time>

Date and time when the resource was created

Example:

"2023-01-01T12:04:05Z"

data.quoteExpireDate

string<date-time>

Date and time when the resource expires

Example:

"2023-01-01T12:04:05Z"

data.cryptoFundsSettlementExpireDate

string<date-time>

Date and time when the resource expires

Example:

"2023-01-01T12:04:05Z"

data.sourceAmount

object

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

Show child attributes

data.sourceAmount.amount

string

Example:

"110.270000"

data.sourceAmount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{ "amount": "10.000000", "currency": "USDC" }

data.destinationAmount

object

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

Show child attributes

data.destinationAmount.amount

string

Example:

"183.24"

data.destinationAmount.currency

enum<string>

Supported fiat currencies

Available options:

BRL,

CNY,

COP,

EUR,

GBP,

HKD,

INR,

MXN,

NGN,

USD

Example:

"MXN"

Example:

{ "amount": "183.24", "currency": "MXN" }

data.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 child attributes

data.fiatSettlementTime.max

string

Example:

"3"

data.fiatSettlementTime.min

string

Example:

"1"

data.fiatSettlementTime.unit

enum<string>

Available options:

MINUTES,

HOURS,

DAYS,

WEEKS

Example:

"DAYS"

data.exchangeRate

object

Show child attributes

data.exchangeRate.pair

string

The currency pair in format cryptoCurrency/localFiatCurrency

Example:

"USDC/MXN"

data.exchangeRate.rate

string

The exchange rate between source and destination currencies

Example:

"18.324000"

Example:

{ "pair": "USDC/MXN", "rate": "18.324000" }

data.fees

object

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

Show child attributes

data.fees.breakdown

object[]

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

Show child attributes

data.fees.breakdown.amount

object

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

Show child attributes

data.fees.breakdown.amount.amount

string

Example:

"110.270000"

data.fees.breakdown.amount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{
  "amount": "110.270000",
  "currency": "USDC"
}

data.fees.breakdown.type

enum<string>

The type of fee being charged for the transaction.

Available options:

TAX_FEE,

BFI_TRANSACTION_FEE

Example:

"BFI_TRANSACTION_FEE"

data.fees.totalAmount

object

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

Show child attributes

data.fees.totalAmount.amount

string

Example:

"110.270000"

data.fees.totalAmount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{
  "amount": "110.270000",
  "currency": "USDC"
}

Example:

{
  "breakdown": [
    {
      "type": "BFI_TRANSACTION_FEE",
      "amount": { "amount": "0.240000", "currency": "USDC" }
    }
  ],
  "totalAmount": { "amount": "0.240000", "currency": "USDC" }
}

data.senderType

enum<string>

Type of entity sending or receiving the payment

Available options:

BUSINESS,

INDIVIDUAL

Example:

"BUSINESS"

data.recipientType

enum<string>

Type of entity sending or receiving the payment

Available options:

BUSINESS,

INDIVIDUAL

Example:

"BUSINESS"

data.certificate

object

Show child attributes

data.certificate.id

string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.certificate.certPem

file

Base64 encoded certificate in PEM format

Example:

"LS0tLS1CRUdJT..."

data.certificate.domain

string

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

Example:

"api.circle.com"

data.certificate.jwk

object

The public key for the BFI defined in RFC 7517

Show child attributes

data.certificate.jwk.crv

string

The curve used for the EC key

Example:

"P-256"

data.certificate.jwk.kid

string

Key ID

Example:

"263521881931753643998528753619816524468853605762"

data.certificate.jwk.kty

string

Key type

Example:

"EC"

data.certificate.jwk.x

string

X coordinate for the EC public key

Example:

"KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE"

data.certificate.jwk.y

string

Y coordinate for the EC public key

Example:

"D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"

data.quoteOptions

object

Additional information for the OFI to provide a more precise quote

Show child attributes

data.quoteOptions.isFirstParty

boolean

Whether the sender and recipient are the same entity. Some BFIs may provide discounts for first party payments.

API Overview

Circle Payments Network

Get details of a quote

Authorizations

Path Parameters

Response