Sign in

v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014667228.9 KB
Intents

Create new intent

Creates a new payment intent with cross-chain transfer parameters

post/intents

Request body

senderstring

Sender wallet address on the source chain

paymentLinkIdstring

Payment link ID associated with the intent

amountstring required

Amount to transfer in smallest unit (e.g., wei for ETH).

amountSymbolstring required

Token symbol for amount denomination (e.g., USDC, USDT, ETH)

tokenInstring required

Token address on the source chain

source_chain'ARBITRUM_MAINNET' | 'ARBITRUM_TESTNET' | 'AVALANCHE_MAINNET' | 'AVALANCHE_TESTNET' | 'BASE_MAINNET' | 'BASE_TESTNET' | 'STARKNET_MAINNET' | 'STARKNET_TESTNET' | 'BSC_MAINNET' | 'ETHEREUM_MAINNET' | 'ETHEREUM_TESTNET' | 'OPTIMISM_MAINNET' | 'OPTIMISM_TESTNET' | 'MONAD_MAINNET' | 'MONAD_TESTNET' | 'POLYGON_MAINNET' | 'HYPEREVM_MAINNET' | 'LISK_MAINNET' | 'SOLANA_MAINNET' | 'SOLANA_TESTNET' | 'TRON_MAINNET' required

Source blockchain network for the deposit

destination_chain'ARBITRUM_MAINNET' | 'ARBITRUM_TESTNET' | 'AVALANCHE_MAINNET' | 'AVALANCHE_TESTNET' | 'BASE_MAINNET' | 'BASE_TESTNET' | 'STARKNET_MAINNET' | 'STARKNET_TESTNET' | 'BSC_MAINNET' | 'ETHEREUM_MAINNET' | 'ETHEREUM_TESTNET' | 'OPTIMISM_MAINNET' | 'OPTIMISM_TESTNET' | 'MONAD_MAINNET' | 'MONAD_TESTNET' | 'POLYGON_MAINNET' | 'HYPEREVM_MAINNET' | 'LISK_MAINNET' | 'SOLANA_MAINNET' | 'SOLANA_TESTNET' | 'TRON_MAINNET' required

Source blockchain network for the deposit

recipientstring required

Recipient wallet address on the destination chain

refund_addressstring

Refund address on the source chain if intent fails

metadataobject

Additional metadata for the intent

Example request

{
  "sender": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "paymentLinkId": "pl_xw1nw5rpaj",
  "amount": "1000000000000000000",
  "amountSymbol": "USDC",
  "tokenIn": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "recipient": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
  "refund_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "metadata": {
    "orderId": "12345",
    "userId": "user-abc"
  }
}

Response

Intent successfully created

idnumber
client_idstring
senderstring
initialAmountstring
fees_in_usdstring
app_fee_in_usdstring
total_amount_in_usdstring
total_amount_in_asset_tokenstring
fees_in_asset_tokenstring
app_fee_in_asset_tokenstring
asset_token_symbolstring
asset_token_decimalsnumber
slippagestring
tokenInstring
tokenOutstring
intent_addressstring

Solana: intent PDA — show to users for QR/Send; transfer tokenIn here (wallet derives deposit ATA). EVM/Starknet: contract address.

source_chainstring
destination_chainstring
recipientstring
refund_addressstring
relayerstring
coordinatorstring
bridgerstring
bridgeExtraDatastring
intent_noncenumber
intent_status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED'
tx_hashstring nullable
needs_relayboolean
expires_atstring date-time
metadataobject
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 2,
  "client_id": "e1ee3675-cb26-4a76-8206-a84f86e85862",
  "sender": "0xdA3ECb2E5362295E2b802669dD47127A61d9Ce54",
  "initialAmount": "1000000",
  "fees_in_usd": "500",
  "app_fee_in_usd": "1000",
  "total_amount_in_usd": "1010500",
  "total_amount_in_asset_token": "1000500",
  "fees_in_asset_token": "500",
  "app_fee_in_asset_token": "0",
  "asset_token_symbol": "USDC",
  "asset_token_decimals": 6,
  "slippage": "0.5",
  "tokenIn": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
  "tokenOut": "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
  "intent_address": "0x4E60e01263E750eD9D087157e19D2480Fd86A900",
  "source_chain": "BASE_TESTNET",
  "destination_chain": "ARBITRUM_TESTNET",
  "recipient": "0xb79541Be080a59fdcE6C0b43219ba56c725eC65e",
  "refund_address": "0xb79541Be080a59fdcE6C0b43219ba56c725eC65e",
  "coordinator": "0x989f47053F188778575113DcF39dB8960Fc450e2",
  "bridger": "0xa1c943058a631D5506eb7d96036eAbF6968e2338",
  "bridgeExtraData": "0x00000000000000000000000000000000000000000000000000000000000001f400000000000000000000000000000000000000000000000000000000000003e8000000000000000000000000000000000000000000000000000000000000000300000000000000000000000075faf114eafb1bdbe2f0316df893fd58ce46aa4d",
  "intent_nonce": 4267684716645197,
  "intent_status": "PENDING",
  "expires_at": "2025-11-11T02:31:23.000Z",
  "metadata": {
    "priority": "normal",
    "description": "Cross-chain USDC transfer"
  },
  "created_at": "2025-11-11T01:31:23.390Z",
  "updated_at": "2025-11-11T01:31:23.390Z"
}