Sign in

v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014667228.9 KB
Modal Sessions

Create a modal session

Creates a modal session with constraints (recipient, token, chain, amount). Returns a session token valid for 60 minutes.

post/modal/sessions

Request body

recipientstring required

Recipient wallet address on the destination chain

tokenOutstring required

Token address on the destination chain

destinationChain'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

amountstring required

Amount in human-readable format (e.g., "1" for 1 token, "100" for 100 tokens, "1.5" for 1.5 tokens). Set to "0" to allow user to input any amount > 0

Example request

{
  "recipient": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
  "tokenOut": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "amount": "1"
}

Response

Session created successfully

sessionIdstring required

Unique session identifier

sessionTokenstring required

JWT session token for authentication

expiresAtstring date-time required

Token expiration timestamp

Example response

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresAt": "2025-12-24T13:45:30.000Z",
  "client": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Corp",
    "email": "contact@acme.com",
    "logoUrl": "https://acme.com/logo.png",
    "merchantKybVerified": true
  }
}