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}
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.

Path Parameters

sessionId string (uuid) required path
Checkout session UUID
Example: "550e8400-e29b-41d4-a716-446655440000"

Query Parameters

include string optional query
Pass 'order' to embed the full order object with transactions in the response

Responses

200 Checkout session retrieved successfully
application/json
success boolean REQUIRED
message string REQUIRED
data object REQUIRED
Checkout session state with order link
id string (uuid) REQUIRED
status string REQUIRED
Checkout session status
Enum: open, processing, complete, expired
success_url string | null REQUIRED
Resolved success redirect URL (template variables replaced)
cancel_url string | null REQUIRED
Resolved cancel redirect URL (template variables replaced)
metadata object REQUIRED
order_id string (uuid) | null REQUIRED
Linked order ID (null before order creation)
client_reference_id string | null REQUIRED
Merchant-side reference ID
expires_at string (date-time) REQUIRED
created_at string (date-time) REQUIRED
order object | null
Full order with transactions. Only included when ?include=order is passed.
order object & object | object & object | object & object | object & object | object & object | object & object | object & object | object & object | object & object REQUIRED
One of:
Option 1
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: swap
payload object REQUIRED
Swap-specific payload
expectedDstAmount string REQUIRED
Expected amount of destination tokens
metadata object REQUIRED
Swap metadata for display purposes
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
Option 2
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: x402_swap
payload object REQUIRED
X402 swap-specific payload
expectedDstAmount string REQUIRED
Expected amount of destination tokens
metadata object REQUIRED
X402 swap metadata for display purposes
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
Option 3
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: hype_duel
payload object REQUIRED
HypeDuel-specific payload
expectedDstAmount string REQUIRED
Expected amount of destination tokens
metadata object REQUIRED
HypeDuel metadata for display purposes
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
Option 4
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: custom
payload object REQUIRED
Custom execution payload
data string REQUIRED
Encoded transaction data
to string REQUIRED
Target contract address
spenderAddress string
Optional spender address for token approval
amount string REQUIRED
Amount for the custom operation
metadata object REQUIRED
Custom metadata for display purposes
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
action string
Optional custom action identifier
Option 5
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: custom_exact_in
payload object REQUIRED
Custom exact in execution payload
amount string REQUIRED
Amount used when executing the destination function
expectedDstAmount string REQUIRED
Expected amount of destination tokens
functionAbi string REQUIRED
JSON stringified ABI that includes the destination function
functionName string REQUIRED
Destination function name
functionArgs string[] REQUIRED
Destination function arguments (template variables allowed)
Array of: ...
to string REQUIRED
Destination contract address
spenderAddress string
Optional spender address for token approval
value string
Native token value to send with the transaction (in wei)
action string
Optional action identifier used for display purposes
metadata object REQUIRED
Custom metadata for display purposes
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
action string
Optional custom action identifier
Option 6
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: mint_nft
payload object REQUIRED
NFT minting payload
contractAddress string REQUIRED
NFT contract address
tokenId number | null REQUIRED
Token ID (for ERC1155, null for ERC721)
contractType string REQUIRED
Type of NFT contract
Enum: erc721, erc1155
nftPrice string REQUIRED
Price to mint the NFT
metadata object REQUIRED
NFT metadata
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
nft object | object REQUIRED
One of:
Option 1...
Option 2...
Option 7
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: join_tournament
payload object REQUIRED
Tournament joining payload
contractAddress string REQUIRED
Tournament contract address
entryPrice string REQUIRED
Tournament entry price
metadata object REQUIRED
Tournament metadata
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
tournament object REQUIRED
Tournament details
slug string REQUIRED
Tournament slug identifier
name string REQUIRED
Tournament name
description string REQUIRED
Tournament description
imageUrl string REQUIRED
Tournament image URL
Option 8
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type
Enum: fund_tournament
payload object REQUIRED
Tournament funding payload
contractAddress string REQUIRED
Tournament contract address
fundAmount string REQUIRED
Amount to fund the tournament
metadata object REQUIRED
Tournament metadata
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
tournament object REQUIRED
Tournament details
slug string REQUIRED
Tournament slug identifier
name string REQUIRED
Tournament name
description string REQUIRED
Tournament description
imageUrl string REQUIRED
Tournament image URL
Option 9
id string (uuid) REQUIRED
Unique order identifier
recipientAddress string REQUIRED
Address to receive tokens/NFT/etc
globalAddress string REQUIRED
Global wallet address handling the order
srcChain number REQUIRED
Source chain ID
dstChain number REQUIRED
Destination chain ID
srcTokenAddress string REQUIRED
Source token contract address
dstTokenAddress string REQUIRED
Destination token contract address
srcAmount string REQUIRED
Source amount
status string REQUIRED
Current order status
Enum: scanning_deposit_transaction, waiting_stripe_payment, expired, sending_token_from_vault, quoting_after_deposit, relay, executing, executed, refunding, refunded, failure
errorDetails string | null REQUIRED
Error details if order failed
createdAt number REQUIRED
Creation timestamp
expiredAt number REQUIRED
Expiration timestamp
filledAt number | null REQUIRED
Timestamp when the order was filled/executed
receivedDepositAt number | null REQUIRED
Timestamp when the deposit was received
creatorAddress string | null REQUIRED
Optional creator address
partnerId string | null REQUIRED
Optional partner identifier
clientReferenceId string | null
Optional client reference identifier for tracking purposes (alphanumeric, hyphens, and underscores only, max 255 chars)
onrampMetadata object | null REQUIRED
Onramp configuration if used
country string REQUIRED
Country code
vendor string REQUIRED
Onramp vendor used
Enum: coinbase, stripe, stripe-web2, none
paymentMethod string REQUIRED
Payment method used
redirectUrl string REQUIRED
Redirect URL after payment
stripeAmountInCents number
Stripe payment amount in cents
ipAddress string (ipv4)
Optional IP address for location detection. Required for Stripe onramp requests in production and omitted from standard order responses.
fingerprint object
Optional fingerprint data for fraud detection
requestId string REQUIRED
Fingerprint request ID
visitorId string REQUIRED
Fingerprint visitor ID
oneClickBuyUrl string | null REQUIRED
Quick purchase URL if available
stripePaymentIntentId string | null REQUIRED
Stripe payment intent ID if using Stripe
settlement object | null REQUIRED
Settlement information for executed orders
actualDstAmount string
Actual received amount after execution (only for swap/hypeduel orders). Optional - only present for swap/hypeduel orders.
relay 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.
fee object | object | null
Fee structure for the order including Stripe and AnySpend fees
type string REQUIRED
Order type for deposit-first flow where amount is determined after deposit
Enum: deposit_first
payload object REQUIRED
DepositFirst payload - empty at creation time, details determined after deposit is detected
metadata object REQUIRED
DepositFirst metadata for display purposes
srcToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
dstToken object REQUIRED
Token details
chainId number REQUIRED
Token chain ID
address string REQUIRED
Token contract address
symbol string REQUIRED
Token symbol
name string REQUIRED
Token name
decimals number REQUIRED
Token decimals
metadata object REQUIRED
...
depositTxs object[] REQUIRED
Array of:
orderId string (uuid) REQUIRED
Associated order ID
chain number REQUIRED
Chain where transaction occurred
from string | null
Sender address (can be null)
txHash string REQUIRED
Transaction hash
amount string REQUIRED
Transaction amount
createdAt number REQUIRED
Transaction timestamp
relayTxs object[] REQUIRED
Array of:
orderId string (uuid) REQUIRED
Associated order ID
chain number REQUIRED
Chain where relay occurred
txHash string REQUIRED
Relay transaction hash
status string REQUIRED
Relay transaction status
Enum: pending, success, failure, refund, delayed, waiting
createdAt number REQUIRED
Relay timestamp
executeTx object | null REQUIRED
orderId string (uuid) REQUIRED
Associated order ID
chain number REQUIRED
Chain where execution occurred
txHash string REQUIRED
Execution transaction hash
createdAt number REQUIRED
Execution timestamp
refundTxs object[] REQUIRED
Array of:
orderId string (uuid) REQUIRED
Associated order ID
chain number REQUIRED
Chain where refund occurred
txHash string REQUIRED
Refund transaction hash
amount string REQUIRED
Refunded amount
status string REQUIRED
Refund status
Enum: success, failure
createdAt number REQUIRED
Refund timestamp
points number | null REQUIRED
statusCode number REQUIRED
400 Checkout session not found 
curl -X GET 'https://mainnet.anyspend.com/checkout-sessions/550e8400-e29b-41d4-a716-446655440000'
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);
import requestsresponse = requests.get('https://mainnet.anyspend.com/checkout-sessions/550e8400-e29b-41d4-a716-446655440000')print(response.json())
200 Response 
{  "success": true,  "message": "Checkout session retrieved",  "data": {    "id": "<uuid>",    "status": "open",    "success_url": "<string>",    "cancel_url": "<string>",    "metadata": "<object>",    "order_id": "<uuid>",    "client_reference_id": "<string>",    "expires_at": "2024-01-01T00:00:00Z",    "created_at": "2024-01-01T00:00:00Z",    "order": {      "order": {        "id": "5392f7a7-d472-4d6b-9848-bd07117fb82d",        "recipientAddress": "0xb34facb90a200251318e8841c05102366f2158cf",        "globalAddress": "0xa640beaa78eeb64bb269f2baf8202b9a7316e123",        "srcChain": 8453,        "dstChain": 8453,        "srcTokenAddress": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",        "dstTokenAddress": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",        "srcAmount": "93354000",        "status": "executed",        "errorDetails": "<string>",        "createdAt": 1752505794679,        "expiredAt": 1752506694679,        "filledAt": 123,        "receivedDepositAt": 123,        "creatorAddress": "0xb34facb90a200251318e8841c05102366f2158cf",        "partnerId": "<string>",        "clientReferenceId": "<string>",        "onrampMetadata": {          "country": {},          "vendor": {},          "paymentMethod": {},          "redirectUrl": {},          "stripeAmountInCents": {},          "ipAddress": {},          "fingerprint": {}        },        "oneClickBuyUrl": "<string>",        "stripePaymentIntentId": "pi_3Rko0sJnoDg53PsP0PDLsHkR",        "settlement": {          "actualDstAmount": {},          "relay": {}        },        "fee": {},        "type": "swap",        "payload": {          "expectedDstAmount": {}        },        "metadata": {          "srcToken": {},          "dstToken": {}        }      },      "depositTxs": [        {          "orderId": "5392f7a7-d472-4d6b-9848-bd07117fb82d",          "chain": 8453,          "from": "0xa7539e73700B1726aBA29526606442A491Ef5747",          "txHash": "0x60ece99a645201668d20db6775a6b3d30967433ff0750b356cdad46d3e13f9c8",          "amount": "93354000",          "createdAt": 1752505811105        }      ],      "relayTxs": [        {          "orderId": "5392f7a7-d472-4d6b-9848-bd07117fb82d",          "chain": 8453,          "txHash": "0x9df917e14bb089f74763d1d2662761d75c97a5a068b8a9e411c3d384c9c40d19",          "status": "pending",          "createdAt": 1752505817654        }      ],      "executeTx": {        "orderId": "5392f7a7-d472-4d6b-9848-bd07117fb82d",        "chain": 8453,        "txHash": "0x1234567890abcdef1234567890abcdef12345678",        "createdAt": 1752505820000      },      "refundTxs": [        {          "orderId": "5392f7a7-d472-4d6b-9848-bd07117fb82d",          "chain": 8453,          "txHash": "0xabcdef1234567890abcdef1234567890abcdef12",          "amount": "93354000",          "status": "success",          "createdAt": 1752505825000        }      ],      "points": 123    }  },  "statusCode": 200}
Previous Create a checkout session
Next Expire a checkout session