> ## Documentation Index > Fetch the complete documentation index at: https://docs.anyspend.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a checkout session Retrieves a checkout session with current status, payment config, and optionally the full order with transactions. Status is synced from the underlying order on each retrieval. ` GET /checkout-sessions/{sessionId} ` Get a checkout session Retrieves a checkout session with current status, payment config, and optionally the full order with transactions. Status is synced from the underlying order on each retrieval. ## Servers - ` https://mainnet.anyspend.com ` — Production server ## Parameters ### ` sessionId ` (path, required) Checkout session UUID - ` value `: type ` string `; format ` uuid ` Example: ```json "550e8400-e29b-41d4-a716-446655440000" ``` ### ` include ` (query, optional) Pass 'order' to embed the full order object with transactions in the response - ` value `: type ` string ` - enum: ` ["order"] ` ## Responses ### ` 200 ` — Checkout session retrieved successfully Content type: ` application/json ` - ` value `: type ` object ` - Required fields: ` success `, ` message `, ` data `, ` statusCode ` - ` success `: type ` boolean ` - example: ` true ` - ` message `: type ` string ` - example: ` "Checkout session retrieved" ` - ` data `: type ` object ` — Checkout session state with order link - Required fields: ` id `, ` status `, ` success_url `, ` cancel_url `, ` metadata `, ` order_id `, ` client_reference_id `, ` expires_at `, ` created_at ` - ` id `: type ` string `; format ` uuid ` - ` status `: type ` string ` — Checkout session status - enum: ` ["open","processing","complete","expired"] ` - ` success_url `: type ` string `; nullable — Resolved success redirect URL (template variables replaced) - ` cancel_url `: type ` string `; nullable — Resolved cancel redirect URL (template variables replaced) - ` metadata `: type ` object ` - ` order_id `: type ` string `; nullable; format ` uuid ` — Linked order ID (null before order creation) - ` client_reference_id `: type ` string `; nullable — Merchant-side reference ID - ` expires_at `: type ` string `; format ` date-time ` - ` created_at `: type ` string `; format ` date-time ` - ` order `: type ` object `; nullable — Full order with transactions. Only included when ?include=order is passed. - Required fields: ` order `, ` depositTxs `, ` relayTxs `, ` executeTx `, ` refundTxs `, ` points ` - ` order `: type ` unknown ` - ` oneOf alternative 1 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["swap"] ` - ` payload `: type ` object ` — Swap-specific payload - Required fields: ` expectedDstAmount ` - ` expectedDstAmount `: type ` string ` — Expected amount of destination tokens - example: ` "990000" ` - ` metadata `: type ` object ` — Swap metadata for display purposes - Required fields: ` srcToken `, ` dstToken ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` oneOf alternative 2 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["x402_swap"] ` - ` payload `: type ` object ` — X402 swap-specific payload - Required fields: ` expectedDstAmount ` - ` expectedDstAmount `: type ` string ` — Expected amount of destination tokens - example: ` "990000" ` - ` metadata `: type ` object ` — X402 swap metadata for display purposes - Required fields: ` srcToken `, ` dstToken ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` oneOf alternative 3 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["hype_duel"] ` - ` payload `: type ` object ` — HypeDuel-specific payload - Required fields: ` expectedDstAmount ` - ` expectedDstAmount `: type ` string ` — Expected amount of destination tokens - example: ` "990000" ` - ` metadata `: type ` object ` — HypeDuel metadata for display purposes - Required fields: ` srcToken `, ` dstToken ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` oneOf alternative 4 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["custom"] ` - ` payload `: type ` object ` — Custom execution payload - Required fields: ` data `, ` to `, ` amount ` - ` data `: type ` string ` — Encoded transaction data - example: ` "0x1234567890abcdef..." ` - ` to `: type ` string ` — Target contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` spenderAddress `: type ` string ` — Optional spender address for token approval - example: ` "0x58241893EF1f86C9fBd8109Cd44Ea961fDb474e1" ` - ` amount `: type ` string ` — Amount for the custom operation - example: ` "1000000" ` - ` metadata `: type ` object ` — Custom metadata for display purposes - Required fields: ` srcToken `, ` dstToken ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` action `: type ` string ` — Optional custom action identifier - example: ` "claim-reward" ` - ` oneOf alternative 5 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["custom_exact_in"] ` - ` payload `: type ` object ` — Custom exact in execution payload - Required fields: ` amount `, ` expectedDstAmount `, ` functionAbi `, ` functionName `, ` functionArgs `, ` to ` - ` amount `: type ` string ` — Amount used when executing the destination function - example: ` "1000000000000000000" ` - ` expectedDstAmount `: type ` string ` — Expected amount of destination tokens - example: ` "1000000000000000000" ` - ` functionAbi `: type ` string ` — JSON stringified ABI that includes the destination function - ` functionName `: type ` string ` — Destination function name - example: ` "stake" ` - ` functionArgs `: type ` array ` — Destination function arguments (template variables allowed) - ` array item `: type ` string ` - ` to `: type ` string ` — Destination contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` spenderAddress `: type ` string ` — Optional spender address for token approval - example: ` "0x58241893EF1f86C9fBd8109Cd44Ea961fDb474e1" ` - ` value `: type ` string ` — Native token value to send with the transaction (in wei) - example: ` "1000000000000000000" ` - ` action `: type ` string ` — Optional action identifier used for display purposes - example: ` "stake B3" ` - ` metadata `: type ` object ` — Custom metadata for display purposes - Required fields: ` srcToken `, ` dstToken ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` action `: type ` string ` — Optional custom action identifier - example: ` "claim-reward" ` - ` oneOf alternative 6 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["mint_nft"] ` - ` payload `: type ` object ` — NFT minting payload - Required fields: ` contractAddress `, ` tokenId `, ` contractType `, ` nftPrice ` - ` contractAddress `: type ` string ` — NFT contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` tokenId `: type ` number `; nullable — Token ID (for ERC1155, null for ERC721) - example: ` 1 ` - ` contractType `: type ` string ` — Type of NFT contract - enum: ` ["erc721","erc1155"] ` - example: ` "erc721" ` - ` nftPrice `: type ` string ` — Price to mint the NFT - example: ` "1000000" ` - ` metadata `: type ` object ` — NFT metadata - Required fields: ` srcToken `, ` dstToken `, ` nft ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` nft `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — ERC721 NFT - Required fields: ` type `, ` contractAddress `, ` name `, ` description `, ` imageUrl ` - ` type `: type ` string ` — NFT type - enum: ` ["erc721"] ` - ` contractAddress `: type ` string ` — NFT contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` name `: type ` string ` — NFT name - example: ` "Cool NFT" ` - ` description `: type ` string ` — NFT description - example: ` "A very cool NFT" ` - ` imageUrl `: type ` string ` — NFT image URL - example: ` "https://example.com/nft.png" ` - ` oneOf alternative 2 `: type ` object ` — ERC1155 NFT - Required fields: ` type `, ` contractAddress `, ` name `, ` description `, ` imageUrl `, ` tokenId ` - ` type `: type ` string ` — NFT type - enum: ` ["erc1155"] ` - ` contractAddress `: type ` string ` — NFT contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` name `: type ` string ` — NFT name - example: ` "Cool NFT" ` - ` description `: type ` string ` — NFT description - example: ` "A very cool NFT" ` - ` imageUrl `: type ` string ` — NFT image URL - example: ` "https://example.com/nft.png" ` - ` tokenId `: type ` number ` — Token ID for ERC1155 - example: ` 1 ` - ` oneOf alternative 7 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["join_tournament"] ` - ` payload `: type ` object ` — Tournament joining payload - Required fields: ` contractAddress `, ` entryPrice ` - ` contractAddress `: type ` string ` — Tournament contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` entryPrice `: type ` string ` — Tournament entry price - example: ` "1000000" ` - ` metadata `: type ` object ` — Tournament metadata - Required fields: ` srcToken `, ` dstToken `, ` tournament ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` tournament `: type ` object ` — Tournament details - Required fields: ` slug `, ` name `, ` description `, ` imageUrl ` - ` slug `: type ` string ` — Tournament slug identifier - example: ` "summer-championship-2024" ` - ` name `: type ` string ` — Tournament name - example: ` "Summer Championship 2024" ` - ` description `: type ` string ` — Tournament description - example: ` "The biggest tournament of the summer" ` - ` imageUrl `: type ` string ` — Tournament image URL - example: ` "https://example.com/tournament.png" ` - ` oneOf alternative 8 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type - enum: ` ["fund_tournament"] ` - ` payload `: type ` object ` — Tournament funding payload - Required fields: ` contractAddress `, ` fundAmount ` - ` contractAddress `: type ` string ` — Tournament contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` fundAmount `: type ` string ` — Amount to fund the tournament - example: ` "1000000" ` - ` metadata `: type ` object ` — Tournament metadata - Required fields: ` srcToken `, ` dstToken `, ` tournament ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` tournament `: type ` object ` — Tournament details - Required fields: ` slug `, ` name `, ` description `, ` imageUrl ` - ` slug `: type ` string ` — Tournament slug identifier - example: ` "summer-championship-2024" ` - ` name `: type ` string ` — Tournament name - example: ` "Summer Championship 2024" ` - ` description `: type ` string ` — Tournament description - example: ` "The biggest tournament of the summer" ` - ` imageUrl `: type ` string ` — Tournament image URL - example: ` "https://example.com/tournament.png" ` - ` oneOf alternative 9 `: type ` unknown ` - ` allOf constraint 1 `: type ` object ` — Base order fields - Required fields: ` id `, ` type `, ` recipientAddress `, ` globalAddress `, ` srcChain `, ` dstChain `, ` srcTokenAddress `, ` dstTokenAddress `, ` srcAmount `, ` status `, ` errorDetails `, ` createdAt `, ` expiredAt `, ` filledAt `, ` receivedDepositAt `, ` creatorAddress `, ` partnerId `, ` onrampMetadata `, ` oneClickBuyUrl `, ` stripePaymentIntentId `, ` settlement `, ` payload `, ` metadata ` - ` id `: type ` string `; format ` uuid ` — Unique order identifier - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` recipientAddress `: type ` string ` — Address to receive tokens/NFT/etc - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` globalAddress `: type ` string ` — Global wallet address handling the order - example: ` "0xa640beaa78eeb64bb269f2baf8202b9a7316e123" ` - ` srcChain `: type ` number ` — Source chain ID - example: ` 8453 ` - ` dstChain `: type ` number ` — Destination chain ID - example: ` 8453 ` - ` srcTokenAddress `: type ` string ` — Source token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` dstTokenAddress `: type ` string ` — Destination token contract address - example: ` "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913" ` - ` srcAmount `: type ` string ` — Source amount - example: ` "93354000" ` - ` status `: type ` string ` — Current order status - enum: ` ["scanning_deposit_transaction","waiting_stripe_payment","expired","sending_token_from_vault","quoting_after_deposit","relay","executing","executed","refunding","refunded","failure"] ` - example: ` "executed" ` - ` errorDetails `: type ` string `; nullable — Error details if order failed - ` createdAt `: type ` number ` — Creation timestamp - example: ` 1752505794679 ` - ` expiredAt `: type ` number ` — Expiration timestamp - example: ` 1752506694679 ` - ` filledAt `: type ` number `; nullable — Timestamp when the order was filled/executed - ` receivedDepositAt `: type ` number `; nullable — Timestamp when the deposit was received - ` creatorAddress `: type ` string `; nullable — Optional creator address - example: ` "0xb34facb90a200251318e8841c05102366f2158cf" ` - ` partnerId `: type ` string `; nullable — Optional partner identifier - ` clientReferenceId `: type ` string `; nullable — Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars) - maxLength: ` 255 ` - pattern: ` "^[a-zA-Z0-9_-]*$" ` - ` onrampMetadata `: type ` unknown `; nullable — Onramp configuration if used - ` allOf constraint 1 `: type ` object ` — Onramp configuration - Required fields: ` country `, ` vendor `, ` paymentMethod `, ` redirectUrl ` - ` country `: type ` string ` — Country code - example: ` "US" ` - ` vendor `: type ` string ` — Onramp vendor used - enum: ` ["coinbase","stripe","stripe-web2","none"] ` - example: ` "stripe-web2" ` - ` paymentMethod `: type ` string ` — Payment method used - example: ` "" ` - ` redirectUrl `: type ` string ` — Redirect URL after payment - example: ` "https://www.anyspend.com" ` - ` stripeAmountInCents `: type ` number ` — Stripe payment amount in cents - example: ` 9900 ` - ` ipAddress `: type ` string `; format ` ipv4 ` — Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses. - example: ` "192.168.1.1" ` - ` fingerprint `: type ` object ` — Optional fingerprint data for fraud detection - Required fields: ` requestId `, ` visitorId ` - ` requestId `: type ` string ` — Fingerprint request ID - example: ` "fp_req_12345" ` - ` visitorId `: type ` string ` — Fingerprint visitor ID - example: ` "fp_visitor_67890" ` - ` oneClickBuyUrl `: type ` string `; nullable — Quick purchase URL if available - ` stripePaymentIntentId `: type ` string `; nullable — Stripe payment intent ID if using Stripe - example: ` "pi_3Rko0sJnoDg53PsP0PDLsHkR" ` - ` settlement `: type ` object `; nullable — Settlement information for executed orders - ` actualDstAmount `: type ` string ` — Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders. - example: ` "990000" ` - ` relay `: type ` object ` — Complete relay API response data. Contains transaction details, state changes, fees, and execution status. Optional - can be backfilled by querying Relay API /requests/v2 endpoint. - example: ` {"status":"success","metadata":{"currencyOut":{"amount":"990000"}}} ` - ` fee `: type ` unknown `; nullable — Fee structure for the order including Stripe and AnySpend fees - ` allOf constraint 1 `: type ` unknown ` - ` oneOf alternative 1 `: type ` object ` — Standard crypto fee structure (non-Stripe transactions) - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` anyspendFeeBps `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["standard_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final fee in basis points after all discounts applied - example: ` 40 ` - ` oneOf alternative 2 `: type ` object ` — Stripe Web2 fee structure including both Stripe and AnySpend fees - Required fields: ` type `, ` feeVersion `, ` tokenToCheckBalance `, ` recipientBalance `, ` stripeFeeBps `, ` stripeFeeUsd `, ` anyspendFeeBps `, ` anyspendFeeUsd `, ` anyspendWhaleDiscountBps `, ` anyspendPartnerDiscountBps `, ` finalFeeBps `, ` finalFeeUsd `, ` originalAmount `, ` finalAmount ` - ` type `: type ` string ` — Fee type identifier - enum: ` ["stripeweb2_fee"] ` - ` feeVersion `: type ` number ` — Fee version number - example: ` 1 ` - ` tokenToCheckBalance `: type ` string ` — Token contract address used to check balance for whale discount (B3 token) - example: ` "0xb3b32f9f8827d4634fe7d973fa1034ec9fddb3b3" ` - ` recipientBalance `: type ` string ` — Recipient's B3 token balance - example: ` "302843673392800000000000" ` - ` stripeFeeBps `: type ` number ` — Stripe fee percentage in basis points (5.4%) - example: ` 540 ` - ` stripeFeeUsd `: type ` number ` — Stripe fixed fee in USD - example: ` 0.3 ` - ` anyspendFeeBps `: type ` number ` — AnySpend base fee in basis points before discounts - example: ` 80 ` - ` anyspendFeeUsd `: type ` number ` — AnySpend fixed fee in USD before discounts - example: ` 0 ` - ` anyspendWhaleDiscountBps `: type ` number ` — Whale discount in basis points based on B3 balance - example: ` 5000 ` - ` anyspendPartnerDiscountBps `: type ` number ` — Partner discount in basis points (deprecated, always 0) - example: ` 0 ` - ` finalFeeBps `: type ` number ` — Final combined fee percentage in basis points after all discounts - example: ` 580 ` - ` finalFeeUsd `: type ` number ` — Final combined fixed fee in USD after all discounts - example: ` 0.3 ` - ` originalAmount `: type ` string ` — Original amount before fees in USDC units (6 decimals) - example: ` "10000000" ` - ` finalAmount `: type ` string ` — Final amount after applying all fees in USDC units (6 decimals) - example: ` "9120000" ` - ` allOf constraint 2 `: type ` object ` - Required fields: ` type `, ` payload `, ` metadata ` - ` type `: type ` string ` — Order type for deposit-first flow where amount is determined after deposit - enum: ` ["deposit_first"] ` - ` payload `: type ` object ` — DepositFirst payload - empty at creation time, details determined after deposit is detected - ` metadata `: type ` object ` — DepositFirst metadata for display purposes - Required fields: ` srcToken `, ` dstToken ` - ` srcToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` dstToken `: type ` object ` — Token details - Required fields: ` chainId `, ` address `, ` symbol `, ` name `, ` decimals `, ` metadata ` - ` chainId `: type ` number ` — Token chain ID - example: ` 8453 ` - ` address `: type ` string ` — Token contract address - example: ` "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" ` - ` symbol `: type ` string ` — Token symbol - example: ` "USDC" ` - ` name `: type ` string ` — Token name - example: ` "USD Coin" ` - ` decimals `: type ` number ` — Token decimals - example: ` 6 ` - ` metadata `: type ` object ` - ` logoURI `: type ` string ` — Token logo URI - example: ` "https://polygonscan.com/token/images/usdc_32.png" ` - ` depositTxs `: type ` array ` - ` array item `: type ` object ` — Deposit transaction (payment from user) - Required fields: ` orderId `, ` chain `, ` txHash `, ` amount `, ` createdAt ` - ` orderId `: type ` string `; format ` uuid ` — Associated order ID - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` chain `: type ` number ` — Chain where transaction occurred - example: ` 8453 ` - ` from `: type ` string `; nullable — Sender address (can be null) - example: ` "0xa7539e73700B1726aBA29526606442A491Ef5747" ` - ` txHash `: type ` string ` — Transaction hash - example: ` "0x60ece99a645201668d20db6775a6b3d30967433ff0750b356cdad46d3e13f9c8" ` - ` amount `: type ` string ` — Transaction amount - example: ` "93354000" ` - ` createdAt `: type ` number ` — Transaction timestamp - example: ` 1752505811105 ` - ` relayTxs `: type ` array ` - ` array item `: type ` object ` — Cross-chain relay transaction - Required fields: ` orderId `, ` chain `, ` txHash `, ` status `, ` createdAt ` - ` orderId `: type ` string `; format ` uuid ` — Associated order ID - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` chain `: type ` number ` — Chain where relay occurred - example: ` 8453 ` - ` txHash `: type ` string ` — Relay transaction hash - example: ` "0x9df917e14bb089f74763d1d2662761d75c97a5a068b8a9e411c3d384c9c40d19" ` - ` status `: type ` string ` — Relay transaction status - enum: ` ["pending","success","failure","refund","delayed","waiting"] ` - ` createdAt `: type ` number ` — Relay timestamp - example: ` 1752505817654 ` - ` executeTx `: type ` unknown `; nullable - ` allOf constraint 1 `: type ` object ` — Final execution transaction - Required fields: ` orderId `, ` chain `, ` txHash `, ` createdAt ` - ` orderId `: type ` string `; format ` uuid ` — Associated order ID - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` chain `: type ` number ` — Chain where execution occurred - example: ` 8453 ` - ` txHash `: type ` string ` — Execution transaction hash - example: ` "0x1234567890abcdef1234567890abcdef12345678" ` - ` createdAt `: type ` number ` — Execution timestamp - example: ` 1752505820000 ` - ` refundTxs `: type ` array ` - ` array item `: type ` object ` — Refund transaction if order failed - Required fields: ` orderId `, ` chain `, ` txHash `, ` amount `, ` status `, ` createdAt ` - ` orderId `: type ` string `; format ` uuid ` — Associated order ID - example: ` "5392f7a7-d472-4d6b-9848-bd07117fb82d" ` - ` chain `: type ` number ` — Chain where refund occurred - example: ` 8453 ` - ` txHash `: type ` string ` — Refund transaction hash - example: ` "0xabcdef1234567890abcdef1234567890abcdef12" ` - ` amount `: type ` string ` — Refunded amount - example: ` "93354000" ` - ` status `: type ` string ` — Refund status - enum: ` ["success","failure"] ` - example: ` "success" ` - ` createdAt `: type ` number ` — Refund timestamp - example: ` 1752505825000 ` - ` points `: type ` number `; nullable - ` statusCode `: type ` number ` - example: ` 200 ` ### ` 400 ` — Checkout session not found Content type: ` application/json ` - ` value `: type ` object ` - Required fields: ` success `, ` message `, ` statusCode ` - ` success `: type ` boolean ` - example: ` false ` - ` message `: type ` string ` - example: ` "Checkout session not found" ` - ` statusCode `: type ` number ` - example: ` 400 ` ## Request examples ### cURL ```curl curl -X GET 'https://mainnet.anyspend.com/checkout-sessions/550e8400-e29b-41d4-a716-446655440000' ``` ### JavaScript ```javascript const response = await fetch('https://mainnet.anyspend.com/checkout-sessions/550e8400-e29b-41d4-a716-446655440000', { method: 'GET' }); const data = await response.json(); console.log(data); ``` ### Python ```python import requests response = requests.get('https://mainnet.anyspend.com/checkout-sessions/550e8400-e29b-41d4-a716-446655440000') print(response.json()) ```