Status and history

Use these operations to confirm an intent settled and to look up past intents. For authentication and client setup, see the API overview.

GetIntentReceipt

Returns the current status of an intent and every transaction it produced. Use it to confirm settlement before you fulfill an order or credit an account. Endpoint: POST /GetIntentReceipt

Field	Type	Required	Description
`intentId`	string	Yes	The intent to look up.

Response

Field	Description
`intentReceipt.status`	Intent status. See intent lifecycle.
`intentReceipt.depositTransaction`	The owner’s deposit to the intent address.
`intentReceipt.originTransaction`	Execution on the origin chain.
`intentReceipt.destinationTransaction`	Delivery on the destination chain, when there is one.
`intentReceipt.refundTransaction`	The refund to the owner, when there is one.
`intentReceipt.summary`	Token metadata and the route used.

Each transaction includes chainId, txnHash, fromAddress, toAddress, tokenAddress, tokenAmount, status, and, on failure, statusReason.

const { intentReceipt } = await intents.getIntentReceipt({ intentId });

if (intentReceipt.status === "SUCCEEDED") {
  console.log("Delivered in", intentReceipt.destinationTransaction?.txnHash);
}

WaitIntentReceipt

Holds the request open until the intent changes state, then returns the receipt. Call it in a loop until done is true instead of polling GetIntentReceipt. Endpoint: POST /WaitIntentReceipt

Field	Type	Required	Description
`intentId`	string	Yes	The intent to wait on.

Response

Field	Description
`intentReceipt`	The receipt, as in `GetIntentReceipt`.
`done`	`true` when the intent reached a terminal status.

let receipt = await intents.waitIntentReceipt({ intentId });
while (!receipt.done) {
  receipt = await intents.waitIntentReceipt({ intentId });
}

GetIntent

Returns the full intent, including the original quote request, route, fees, and expiry. Endpoint: POST /GetIntent

Field	Type	Required	Description
`intentId`	string	Yes	The intent to look up.

The response is { intent }, with the same shape QuoteIntent returns.

SearchIntents

Finds intents by an identifier you already have, such as a transaction hash from a customer support request. Endpoint: POST /SearchIntents

Field	Type	Description
`byIntentId`	string	Intent ID.
`byOwnerAddress`	string	Owner address.
`byTransactionHash`	string	Any transaction hash the intent produced.
`byOriginIntentAddress`	string	Intent address on the origin chain.
`byDestinationIntentAddress`	string	Intent address on the destination chain.

Pass at least one field. The response is { intents }.

const { intents: matches } = await intents.searchIntents({ byTransactionHash: "0x..." });

GetIntentHistory

Returns intents with their receipts, with filters and pagination. Use it for activity feeds and reconciliation. Endpoint: POST /GetIntentHistory

Field	Type	Description
`byOwnerAddress`	string	Owner address.
`byStatus`	string	A single status.
`byStatuses`	string[]	Several statuses. Takes precedence over `byStatus`.
`originChainId`	number	Origin chain.
`destinationChainId`	number	Destination chain.
`fromTime`	number	Unix timestamp. Returns intents created at or after this time.
`toTime`	number	Unix timestamp. Returns intents created at or before this time.
`page`	object	`pageSize`, plus the cursor from the previous response.

The response is { intents, nextPage }. Each entry has intentId, status, createdAt, and receipt.

const { intents: history, nextPage } = await intents.getIntentHistory({
  byOwnerAddress: customerAddress,
  page: { pageSize: 20 },
});

Overview

Guides

SDK

API reference

GetIntentReceipt

Response

WaitIntentReceipt

Response

GetIntent

SearchIntents

GetIntentHistory