Create a USDC transfer quote

curl --request POST \
  --url https://iris-api-sandbox.circle.com/v2/quote/burn/usdc/{sourceDomainId}/{destDomainId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1000000",
  "feeToken": "0x0000000000000000000000000000000000000000",
  "requests": [
    {
      "type": "FORWARD"
    },
    {
      "type": "PRE_FINALITY"
    }
  ]
}
'

{
  "signedQuote": "0xabcdef",
  "issuedAt": 1735689540,
  "expiry": {
    "mode": "TIMESTAMP",
    "expiresAt": 1735689600
  },
  "feeTotalAmount": "1000",
  "feeToken": "0x0000000000000000000000000000000000000000",
  "items": [
    {
      "amount": "1000",
      "args": [
        "0x0000000000000000000000000000000000000000000000000000000000000001"
      ],
      "argsHash": "0x1234567890123456789012345678901234567890123456789012345678901234"
    }
  ],
  "nonce": "0",
  "metadata": {
    "exchangeRates": {
      "feeTokenUsd": "1.00",
      "destinationTokenUsd": "1.00"
    }
  }
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

POST

quote

burn

usdc

{sourceDomainId}

{destDomainId}

curl --request POST \
  --url https://iris-api-sandbox.circle.com/v2/quote/burn/usdc/{sourceDomainId}/{destDomainId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "1000000",
  "feeToken": "0x0000000000000000000000000000000000000000",
  "requests": [
    {
      "type": "FORWARD"
    },
    {
      "type": "PRE_FINALITY"
    }
  ]
}
'

{
  "signedQuote": "0xabcdef",
  "issuedAt": 1735689540,
  "expiry": {
    "mode": "TIMESTAMP",
    "expiresAt": 1735689600
  },
  "feeTotalAmount": "1000",
  "feeToken": "0x0000000000000000000000000000000000000000",
  "items": [
    {
      "amount": "1000",
      "args": [
        "0x0000000000000000000000000000000000000000000000000000000000000001"
      ],
      "argsHash": "0x1234567890123456789012345678901234567890123456789012345678901234"
    }
  ],
  "nonce": "0",
  "metadata": {
    "exchangeRates": {
      "feeTokenUsd": "1.00",
      "destinationTokenUsd": "1.00"
    }
  }
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

{
  "errorCode": "VALIDATION_ERROR",
  "error": "Source and destination domain cannot be the same"
}

Path Parameters

sourceDomainId

integer

required

Source domain identifier for the blockchain the transfer starts from. Must be an EVM blockchain where upfront fees are supported, and must satisfy the applicable source-side requirements for included request types. For example, a PRE_FINALITY request requires a source blockchain where Fast Transfer is supported.

Required range: x >= 0

destDomainId

integer

required

Destination domain identifier for the blockchain the transfer settles on. Must differ from sourceDomainId and must satisfy the applicable destination-side requirements for included request types. For example, a FORWARD request requires a destination blockchain where the Forwarding Service is supported.

Required range: x >= 0

Body

application/json

Specifies the transfer amount, fee token, and fees to price for a USDC transfer quote.

amount

string

required

The transfer amount in USDC minor units, as a positive decimal integer string.

Pattern: ^[1-9]\d*$

Example:

"1000000"

requests

(ForwardFeeRequest · object | PreFinalityFeeRequest · object)[]

required

The fees to price. Include a FORWARD request, a PRE_FINALITY request, or both. Each type may appear at most once.

Required array length: 1 - 2 elements

Prices destination-chain forwarding of the transfer.

ForwardFeeRequest
PreFinalityFeeRequest

Show child attributes

Example:

[
  { "type": "FORWARD" },
  { "type": "PRE_FINALITY" }
]

feeToken

string

default:0x0000000000000000000000000000000000000000

The token used to pay fees, as a source-chain EVM address. Defaults to the zero address, which requests fees in the source-chain native gas token.

Pattern: ^0x[a-fA-F0-9]{40}$

Response

Successfully created a signed USDC transfer quote.

A signed, time-bound fee quote for a USDC transfer.

signedQuote

string

required

The signed quote blob to submit to the TokenMessengerWithFees contract.

Pattern: ^0x([a-fA-F0-9]{2})*$

Example:

"0xabcdef"

issuedAt

integer

required

The server time the quote was issued, as a Unix timestamp in seconds. Compute remaining validity relative to this value rather than the client clock.

Example:

1735689540

expiry

TimestampExpiry · object

required

The quote's expiry. The mode field discriminates the shape: TIMESTAMP exposes an exact wall-clock expiresAt, while BLOCK_NUMBER exposes the authoritative onchain expiresAtBlock alongside an advisory blockEstimatedAt.

TimestampExpiry
BlockNumberExpiry

Show child attributes

feeTotalAmount

string

required

The total fee across all items, in the fee token's minor units, as a decimal integer string.

Example:

"1000"

feeToken

string

required

The token the fees are denominated in, as a source-chain EVM address.

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0x0000000000000000000000000000000000000000"

items

object[]

required

The individual fees that sum to feeTotalAmount, one per fee type.

Show child attributes

nonce

string

required

Reserved for future use as a unique identifier for the quote. The TokenMessengerWithFees contract currently enforces a zero nonce.

Example:

"0"

metadata

object

Optional pricing metadata. Present when exchange-rate conversion was applied.

Show child attributes

⌘I