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 messages and attestations

gethttps://iris-api-sandbox.circle.com/v2/messages/{sourceDomainId}

Reference
Playground

Retrieves messages and attestations for a given transaction hash or nonce. Each message for a given transaction hash is ordered by ascending log index.

Path parameters

sourceDomainId

integer

Required

Source domain identifier for a blockchain on CCTP.

Query parameters

transactionHash

string

The transaction hash to filter messages. At least one of transactionHash or nonce is required.

nonce

string

The nonce to filter messages. At least one of transactionHash or nonce is required.

Response

200GetMessagesResponse

Response Body

object

messages

array of objects

Show 9 properties

message

string

The hex-encoded message. 0x if the attestation is not yet available.

eventNonce

string

The nonce associated with the message.

attestation

string

The attestation. PENDING if the attestation is not yet available.

decodedMessage

object

Decoded representation of the message. Null or empty if decoding fails.

Show 10 properties

sourceDomain

string

The ID of a CCTP domain.

destinationDomain

string

The ID of a CCTP domain.

nonce

string

The nonce associated with the message.

sender

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

recipient

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

destinationCaller

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

minFinalityThreshold

string

Minimum finality threshold before allowed to attest.

Allowed values10002000

finalityThresholdExecuted

string

Actual finality threshold executed from source chain.

Allowed values10002000

messageBody

string

Application-specific message to be handled by recipient.

decodedMessageBody

object

Decoded representation of the message body. Null or empty if decoding fails or is not applicable.

Show 8 properties

burnToken

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

mintRecipient

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

amount

string

Amount of burned tokens

messageSender

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

maxFee

string

Maximum fee to pay on the destination domain, specified in units of burnToken.

feeExecuted

string

Actual fee charged on the destination domain, specified in units of burnToken.

expirationBlock

string

Block number at which the message expires.

hookData

string

Arbitrary data to be included in the depositForBurn on source domain that is executed on destination domain.

cctpVersion

integer

status

string

Status of the attestation, whether it is signed or awaiting more block confirmations.

Allowed valuescompletepending_confirmations

delayReason

string

Reason for message processing delay.

Allowed valuesinsufficient_feeamount_above_maxinsufficient_allowance_available

forwardState

string

The state of the forward transaction.

forwardTxHash

string

The transaction hash of the forward transaction.

400BadRequestResponse

404NotFoundResponse

RequestChoose a language

ResponseChoose an example

1{
2  "messages": [
3    {
4      "message": "0x00000000000000050000000300000000000194c2a65fc943419a5ad590042fd67c9791fd015acf53a54cc823edb8ff81b9ed722e00000000000000000000000019330d10d9cc8751218eaf51e8885d058642e08a000000000000000000000000fc05ad74c6fe2e7046e091d6ad4f660d2a15976200000000c6fa7af3bedbad3a3d65f36aabc97431b1bbe4c2d2f6e0e47ca60203452f5d610000000000000000000000002d475f4746419c83be23056309a8e2ac33b30e3b0000000000000000000000000000000000000000000000000000000002b67df0feae5e08f5e6bf04d8c1de7dada9235c56996f4420b14371d6c6f3ddd2f2da78",
5      "eventNonce": "9682",
6      "attestation": "0x6edd90f4a0ad0212fd9fbbd5058a25aa8ee10ce77e4fc143567bbe73fb6e164f384a3e14d350c8a4fc50b781177297e03c16b304e8d7656391df0f59a75a271f1b",
7      "decodedMessage": {
8        "sourceDomain": "0",
9        "destinationDomain": "0",
10        "nonce": "9682",
11        "sender": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
12        "recipient": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
13        "destinationCaller": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
14        "minFinalityThreshold": "1000",
15        "finalityThresholdExecuted": "1000",
16        "messageBody": "",
17        "decodedMessageBody": {
18          "burnToken": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
19          "mintRecipient": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
20          "amount": "10000",
21          "messageSender": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
22          "maxFee": "1000",
23          "feeExecuted": "1000",
24          "expirationBlock": "12345678",
25          "hookData": ""
26        }
27      },
28      "cctpVersion": 2,
29      "status": "complete",
30      "delayReason": "insufficient_fee",
31      "forwardState": "PENDING",
32      "forwardTxHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
33    }
34  ]
35}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy