❓ Query Parameters

Query NameProduct TypeExample ValueTypeDefault ValueDescriptionTags
apiKey *BUY, SELL4fcd6904-706b-4aff-bd9d-77422813bbb7stringYour Transak API Key.
You need to pass this in order to integrate all other parameters. .
You can get it from transak partner dashboard.
Basic
environmentBUY, SELLSTAGINGstringPRODUCTIONTo differentiate between STAGING environment and PRODUCTION environment. This can only be used through Transak SDK.Basic
cryptoCurrencyCodeBUY, SELLDAIstringETH The code of the cryptocurrency you want the customer to buy/sell. If you pass a cryptoCurrencyCode, the crypto currency will be selected by default and the customer won't be able to select another crypto currency. Please ensure that the currency code passed by you is available for the specific product type (BUY/SELL). Do not pass cryptoCurrencyCode param if defaultCryptoCurrency is passed. In case the cryptoCurrencyCode is not part of our crypto coverage for BUY/SELL then it will not be honored wherever it is not present and users will see the default widget with all the supported cryptocurrencies. Ex: If cryptoCurrencyCode=DAI and DAI is live for BUY and not for SELL, then users would see only DAI for BUY but all the supported cryptocurrencies for SELL. You can find the list of supported cryptocurrencies here.Order Data
defaultCryptoCurrencyBUY, SELLDAIstringThe default cryptocurrency you would prefer the customer to buy/sell. If you pass a defaultCryptoCurrency, the currency will be selected by default, but the customer will still be able to select another cryptocurrency. Please ensure that the currency code passed by you is available for the specific product type (BUY/SELL). If you pass a defaultCryptoCurrency that is not supported by BUY/SELL, then the default widget will load. Do not pass cryptoCurrencyCode param if defaultCryptoCurrency is passed.Order Data
cryptoCurrencyListBUY, SELLETH,DAI,USDTstringA comma-separated list of cryptoCurrencies that you would allow your customers to buy/sell. Only these cryptoCurrencies will be shown in the widget. This will be a string of comma separated values each of which will represent a valid cryptoCurrency code. Please ensure that the crypto currency codes passed in the list are available for the specific product type (BUY/SELL). If even one of the crypto currency codes in the list is supported by the specific product type (BUY/SELL), then it will be honored, otherwise the default widget will load for the product type for which none of the crypto currency codes are supported.Advanced, Order Data
networksBUY, SELLethereum, polygon,terra,
mainnet
stringA comma-separated list of crypto networks that you would allow your customers to buy/sell. Only these networks' cryptocurrencies will be shown in the widget. This will be a string of comma-separated values each of which will represent a valid network name. You can get the supporting networks by opening http://global.transak.com and then go to cryptocurrencies select screen. If even one of the networks in the list is supported by the specific product type (BUY/SELL), then it will be honored, otherwise the default widget with all the supported networks will load for the product type for which none of the networks are supported.Advanced, Order Data
networkBUY, SELLethereumstringCrypto network that you would allow your customers to buy. You can get the supporting networks by opening http://global.transak.com and then go to cryptocurrencies select screen. Only the cryptocurrencies supported by this network for the specific product type (BUY/SELL) will be shown in the widget. If the network selected is not supported by a product type (BUY/SELL) then the default widget will all supported networks will be shown.Advanced, Order Data
walletAddressBUY0x86349020e939 4b2BE1b1262531B 0C3335fc32F20stringThe blockchain address of the user's wallet that the purchased cryptocurrency will be sent to. Users will be able to edit the wallet address.The wallet address needs to be valid for the cryptocurrency and blockchain network so to make sure this works you should pass cryptoCurrencyCode or network.
If you want to skip the wallet address screen, then use disableWalletAddressForm
Order Data
walletAddressesDataBUYExampleobject## Here you can pass multiple wallet addresses of the different cryptocurrencies & networks in the JSON object format. Use this query parameter if you are allowing multiple options to your users to buy a cryptocurrency. If you pass the valid wallet addresses, the customer won't be prompted to enter one. If walletAddress is passed, then this field will be ignored. Advanced, Order Data
fiatCurrencyBUY, SELLGBPstringThe code of the fiat currency you want the customer to buy/sell cryptocurrency.
This parameter will be ignored if you don't pass apiKey. If the fiat currency is not supported by a specific product type (BUY/SELL) then the default widget will load with all the supported fiat currencies for that product type.
Order Data
countryCodeBUY, SELLINstringThe country's https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The fiat currency will be displayed as per the country code. This parameter will be skipped if fiatCurrency is passed. If the country code is not supported by a specific product type (BUY/SELL) then the default widget will load with all the supported countries for that product type.Order Data
fiatAmountBUY1100numberAn integer amount representing how much the customer wants to spend/receive. Users can't change the fiat amount if this is passed. This parameter will be skipped if fiatCurrency is not passed. Order Data
defaultNetworkBUY, SELLpolygonstringThe default network you would prefer the customer to purchase/sell on. If you pass a defaultNetwork, the network will be selected by default, but the customer will still be able to select another network. If the default network selected is not supported by a product type (BUY/SELL) then the default widget with all supported networks will be shown.Order Data
defaultFiatAmountBUY1100numberAn integer amount representing how much the customer wants to spend/receive. Users can change the fiat amount if this is passed. This parameter will be skipped if fiatCurrency is not passed.Order Data
defaultCryptoAmountBUY, SELL1numberAn integer amount representing how much crypto the customer wants to buy/sell. This parameter will be skipped if cryptoCurrencyCode or defaultCryptoCurrency is not passed. If the cryptoCurrencyCode is not supported by a specific product type (BUY/SELL) then the query param will not be honored for that product type.

Note : Do not passdefaultFiatAmount if you are using this query parameter. Also, please ensure the defaultCryptoAmount is within our min and max limit for the cryptoCurrencyCode. You can check whether the crypto amount is within permissible limits by going to http://global.transak.com.
New, Order Data
defaultPaymentMethodBUYcredit_debit_cardstringThe default payment method you would prefer the customer to purchase/sell with. If you pass a defaultPaymentMethod, the payment method will be selected by default and the customer can also select another payment method.Order Data
disablePaymentMethodsBUYgbp_bank_transfer, sepa_bank_transferstringA comma-separated list of payment methods you want to disable and hide from the customers. Open this doc to get the possible values.Order Data
emailBUY, SELL[email protected]stringThe email that will be used to identify your customer and their order (usually the email that they registered with your app).KYC
userDataBUY, SELLExampleobjectHere you can pass your user's data like their name, address, date of birth in the object format. If you will pass all the basic user's data, the customer won't be prompted to enter it.Advanced, KYC
partnerOrderIdBUY, SELL5e2f559511a9destringAn order ID that will be used to identify the transaction once a webhook is called back to your app. This can be your identifier to track your customers. Advanced
partnerCustomerIdBUY, SELL23487492stringA customer ID that will be used to identify the customer that made the transaction once a webhook is called back to your app.Advanced
redirectURLBUY, SELLhttps://google.comstringTransak will redirect back to this URL once the customer has completed their purchase/sell process. Please pass the valid URL otherwise it will not work.
Note : if you pass http://localhost url, it wont work.
Advanced
disableWalletAddressFormBUYtruebooleanfalseWhen true, the customer will not be able to change the destination address of where the cryptocurrency is sent to.

Note: When this is used, walletAddress query param should be passed.
Advanced, Look & feel
isAutoFillUserDataBUY, SELLtruebooleanfalseWhen true, then the email address will be auto-filled, but the screen will not be skipped. User can edit their email address, basic data like first name & the address. This parameter will be ignored if email or userData are not passed.Advanced, Look & feel
themeColorBUY, SELL000000stringThe theme color code for the widget main color. It is used for buttons, links and highlighted text. Only hexadecimal codes are accepted.Look & feel
widgetHeightBUY, SELL100%string100%Height of the widget iFrame.
Note: This param will only work with our SDK integration method.
Look & feel
widgetWidthBUY, SELL100%string100%Width of the widget iFrame.
Note: This param will only work with our SDK integration method.
Look & feel
hideMenuBUY, SELLtruebooleanfalseWhen true, then the customer will not see the menu options. This will hide the menu completely.Look & feel
isFeeCalculationHiddenBUY, SELLtruebooleanfalseWhen true, then the customer will not see our fee breakdown. The customer will only see the total fee. This parameter will be ignored if your fee (on top of us) is more than 1%.Advanced, Look & feel
exchangeScreenTitleBUY, SELLBuy CryptostringTo change the exchange screen title. Title cannot be changed if both on ramp and off ramp product are being used. Can only be changed for either on ramp or off ramp.Look & feel
cryptoAmountSELL0.5678numberAn integer amount representing how much crypto the customer wants to sell. Users cannot change the crypto amount if this is passed. This parameter will be skipped if cryptoCurrencyCode is not passed.Order Data
productsAvailedBUY,SELLBUY (OR)
SELL (OR)
BUY,SELL
stringBUY,SELLA string representing the services to be availed and returns the exchange screen accordingly. If only BUY is passed, then users will see the on ramp widget only. If SELL is passed then users will see the off ramp widget only. Only if BUY,SELL is passed, the users will see both the widgets. If BUY,SELL is passed then users will see BUY widget first. Conversely, if SELL,BUY is passed, then users will see the SELL widget first.
Note: If SELL is not enabled by you from your partner portal, then this query param will not be honored and users will see the BUY widget only.
Look & feel
excludeFiatCurrenciesBUY, SELLGBP,EURstringThe fiat currencies passed as comma separated values here will not be shown in the fiat currencies drop down on the widget.
Note: If all the available currencies are present as comma separated values then query param will not be honoured.
Order Data