Query Parameters
Customize On-Ramp, Off-Ramp, and NFT Checkout experiences with query parameters
Customize On-Ramp, Off-Ramp, and NFT Checkout experiences with query parameters
Query Parameters help partners customize the Transak experience across On-Ramp, Off-Ramp, and NFT Checkout flows.
Pass the supported parameters in the widgetParams of the Create Widget URL API to customize the user flow.
apiKey and referrerDomain are mandatory for all products.
Controls the visual look, layout, and product mode of the widget.
Switches between STAGING and PRODUCTION environments.
Height of the widget iFrame.
Width of the widget iFrame.
Widget primary color in hex (e.g. #000000). Used for buttons, links, and highlights.
Defaults to the user’s system theme when not set.
When true, hides the menu options completely.
Services to display: BUY (on-ramp only), SELL (off-ramp only), or BUY,SELL (both). Order controls which tab appears first. SELL must be enabled in the partner portal.
Controls everything visible on the exchange screen — title, currencies, amounts, networks, payment methods, and fee display.
General
Custom title for the exchange screen. Cannot be changed when both BUY and SELL are active simultaneously.
When true, skips the exchange screen entirely. Requires fiatCurrency, network, paymentMethod, and cryptoCurrencyCode for BUY; additionally cryptoAmount for SELL.
When true, hides the fee breakdown and shows only the total fee. Ignored if your fee exceeds 1%.
Fiat Currency
Fiat currency code (e.g. GBP). Customer cannot change.
Default fiat currency; customer can change. Skipped if fiatCurrency or countryCode is passed. Use alongside defaultFiatAmount, not fiatAmount.
Fixed fiat amount. Customer cannot change. Skipped if fiatCurrency or countryCode is not passed.
Default fiat amount; customer can change. Skipped if fiatCurrency/countryCode not passed, or if fiatAmount is set.
ISO 3166-1 alpha-2 country code (e.g. IN). Sets fiat currency based on country. Skipped if fiatCurrency is passed.
Comma-separated fiat currencies to hide from the dropdown (e.g. GBP,EUR). Skipped if fiatCurrency or countryCode is passed.
Crypto Currency
Crypto currency code (e.g. DAI). Customer cannot change. See supported cryptocurrencies.
Default cryptocurrency; customer can change. Skipped if cryptoCurrencyCode is passed.
Comma-separated allowed cryptos (e.g. ETH,DAI,USDT). Skipped if cryptoCurrencyCode is passed.
Default crypto amount. Skipped if cryptoCurrencyCode is not set, or if fiatCurrency + fiatAmount/defaultFiatAmount are passed. Must be within min/max limits.
Fixed crypto amount to sell (e.g. 0.5678). Customer cannot change.
Networks
Single allowed network (e.g. ethereum). Skipped if networks is passed.
Comma-separated list of allowed networks (e.g. ethereum,polygon).
Default network (e.g. polygon). Customer can still select another.
Payment Methods
Payment method to lock in. Customer cannot select another. See payment method list in .
Default payment method; customer can change. Skipped if paymentMethod is passed. See payment method list.
Array of payment methods to hide (e.g. ["gbp_bank_transfer", "sepa_bank_transfer"]). see all the payment methods payment method list.
Controls the destination wallet address for purchased crypto.
Destination wallet address (e.g. 0x8634...). Customer can edit. Pass cryptoCurrencyCode or network alongside.
Multiple wallet addresses keyed by network/coin in JSON format. Skipped if walletAddress is passed. See example.
When true, customer cannot edit the destination address. Requires walletAddress or walletAddressesData.
Enables wallet redirection for off-ramp flows. See details.
Pre-fills customer identity data to streamline or skip the KYC form.
Customer email (e.g. user@mail.com). URL-encode if it contains special characters.
User details (name, address, date of birth). If all fields are provided, the customer won’t be prompted to enter them. See example.
When true, auto-fills the email field without skipping the KYC screen. Ignored if email or userData is not passed.
Session control, partner tracking IDs, and post-transaction redirects.
Your domain URL. Used with apiKey to identify and track your project.
One-time signed URL from the Create Widget URL API. Encapsulates all other parameters securely.
Your internal order ID returned in webhook callbacks (e.g. 5e2f559511a9de).
Your internal customer ID returned in webhook callbacks (e.g. 23487492).
URL to redirect to after the transaction completes. Must be a valid https:// URL. See details.