❓ Query Parameters
| Fields Name | Product Type | Tags | Description | Example | Type | Default Value |
|---|---|---|---|---|---|---|
| apiKey * | BUY, SELL | Basic | Your Transak API Key. You need to pass this in order to integrate all other parameters. . You can get it from transak partner dashboard. | 4fcd6904-706b-4aff-bd9d-77422813bbb7 | String | |
| environment | BUY, SELL | Basic | To differentiate between STAGING environment and PRODUCTION environment. This can only be used through Transak SDK. | STAGING | String | PRODUCTION |
| cryptoCurrencyCode | BUY, SELL | Order Data | 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. | DAI | String | ETH |
| defaultCryptoCurrency | BUY, SELL | Order Data | The 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. | DAI | String | |
| cryptoCurrencyList | BUY, SELL | Advanced, Order Data | A 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. | ETH,DAI,USDT | String | |
| networks | BUY, SELL | Advanced, Order Data | A 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. | ethereum,polygon,terra, mainnet | String | |
| network | BUY, SELL | Advanced, Order Data | Crypto 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. | ethereum | String | |
| walletAddress | BUY | Order Data | The 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 | 0x86349020e9394b2BE1b1262531B0C3335fc32F20 | String | |
| walletAddressesData | BUY | Advanced, Order Data | ## 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. | Example | Object | |
| fiatCurrency | BUY, SELL | Order Data | The 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. | GBP | String | |
| countryCode | BUY, SELL | Order Data | The 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. | IN | String | |
| fiatAmount | BUY | Order Data | An 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. | 1100 | Integer | |
| defaultNetwork | BUY, SELL | Order Data | The 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. | polygon | String | |
| defaultFiatAmount | BUY | Order Data | An 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. | 1100 | Integer | |
| defaultCryptoAmount | BUY, SELL | New, Order Data | An 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. | 1 | Integer | |
| defaultPaymentMethod | BUY | Order Data | The 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. | credit_debit_card | String | |
| disablePaymentMethods | BUY | Order Data | A comma-separated list of payment methods you want to disable and hide from the customers. Open this doc to get the possible values. | gbp_bank_transfer, sepa_bank_transfer | String | |
| BUY, SELL | KYC | The email that will be used to identify your customer and their order (usually the email that they registered with your app). | [email protected] | String | ||
| userData | BUY, SELL | Advanced, KYC | Here 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. | Example | Object | |
| partnerOrderId | BUY, SELL | Advanced | An 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. | 5e2f559511a9de73d364eeaf | String | |
| partnerCustomerId | BUY, SELL | Advanced | A customer ID that will be used to identify the customer that made the transaction once a webhook is called back to your app. | 23487492 | String | |
| redirectURL | BUY, SELL | Advanced | Transak 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. | https://google.com | String | |
| disableWalletAddressForm | BUY | Advanced, Look & feel | When 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. | true | Boolean | false |
| isAutoFillUserData | BUY, SELL | Advanced, Look & feel | When 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. | true | Boolean | false |
| themeColor | BUY, SELL | Look & feel | The theme color code for the widget main color. It is used for buttons, links and highlighted text. Only hexadecimal codes are accepted. | 000000 | String | |
| widgetHeight | BUY, SELL | Look & feel | Height of the widget iFrame. Note: This param will only work with our SDK integration method. | 100% | String | 100% |
| widgetWidth | BUY, SELL | Look & feel | Width of the widget iFrame. Note: This param will only work with our SDK integration method. | 100% | String | 100% |
| hideMenu | BUY, SELL | Look & feel | When true, then the customer will not see the menu options. This will hide the menu completely. | true | Boolean | false |
| isDisableCrypto | BUY | Advanced, Look & feel | When true, then the customer will not see anything about the cryptocurrency. This will hide all the information related to crypto completely. This parameter will be ignored if cryptoCurrencyCode, walletAddress is not passed. This parameter is helpful if you are creating an app for the users who do not know much about the cryptocurrencies. | true | Boolean | false |
| isFeeCalculationHidden | BUY, SELL | Advanced, Look & feel | When 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%. | true | Boolean | false |
| exchangeScreenTitle | BUY, SELL | Look & feel | To 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. | Buy Crypto Instantly | String | Buy crypto to your wallet/Sell crypto from your wallet |
| cryptoAmount | SELL | Order Data | An 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. | 0.5678 | Integer | |
| productsAvailed | BUY,SELL | Look & feel | A 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. | BUY (OR) SELL (OR) BUY, SELL | String | BUY,SELL |
| excludeFiatCurrencies | BUY, SELL | Order Data | The 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. | GBP,EUR etc. | String |
Updated 3 months ago