Skip to main content
Use these endpoints to track the state of an intent after execution and to query historical payment data. For authentication and base URL, see the API overview.

GetIntent

Retrieve the current status and full details of an intent. Endpoint: POST /GetIntent

Request parameters

Response fields

Example


GetIntentReceipt

Get the transaction hashes and settlement status for a completed intent. Use this to confirm that funds arrived at the destination. Endpoint: POST /GetIntentReceipt

Request parameters

Response fields

Example


WaitIntentReceipt

Long-poll until an intent reaches a terminal state (SUCCEEDED or FAILED). The API holds the connection open and responds as soon as the intent settles. Endpoint: POST /WaitIntentReceipt

Request parameters

Response fields

Use WaitIntentReceipt when you want to block until settlement, for example in a server-side payout flow where the next step depends on confirmed settlement. Use GetIntentReceipt polling when you need to check status periodically without holding a connection open.

Example


SearchIntents

Find intents by owner address or transaction hash. Useful for looking up an intent when you have the source transaction hash but not the intent ID. Endpoint: POST /SearchIntents

Request parameters

At least one of ownerAddress or transactionHash is required.

Response fields

Example


GetIntentHistory

Retrieve paginated intent history with receipts for a given address. Returns settled and in-progress intents together with their receipt data where available. Endpoint: POST /GetIntentHistory

Request parameters

Example