Comment on page
✏
Parameters
With these parameters, you can control what your users see when they open your integration
Note: Query params are case sensitive
Field | Values | Type | Default Value |
|---|---|---|---|
apiKey - Required
Kado integrator key. This is a public key used for identifier purposes. | [UUID]
Ex: fa47115e-35e3-11ed-a261-0242ac120002 | String | |
onPayCurrency The fiat currency that will be selected by default for the user to pay in. Users can select any other that is available for selection. | USD, EUR, CAD, GBP, MXN, COP, INR, CHF, AUD, ARS, BRL, CLP, JPY, KRW, PEN, PHP, SGD, TRY, UYU, TWD, VND, CRC, SEK, PLN, DKK, NOK, NZD | String | USD |
onRevCurrency
The cryptocurrency that will be selected by default for the user to buy. Users can select any other that is available for selection.
Note: requires network to be set. | USDT, USDC, SOL, ETH, AVAX, DAI, OSMO, ATOM, BTC, XLM, STARS, SCRT, INJ, CMDX, wETH, wBTC, USDC.e, MATIC, XRP, REGEN, WHALE, BLD, IST, XKI, XPLA | String | |
offPayCurrency The cryptocurrency that will be selected by default for the user to sell. Users can select any other that is available for selection.
Note: Off Ramp currently not available for Arbitrum, Optimism, Polygon | USDT, USDC, SOL, ETH, AVAX, ATOM, BTC, XLM, XRP
| String | |
offRevCurrency The fiat currency that will be selected by default for the user to be paid in. Users can select any other that is available for selection. | USD | String | |
product The option that will be selected by default (on-ramp or off-ramp). Users can change the selection. | BUY, SELL, SWAP | String | |
onPayAmount The amount that will be selected by default for the user to buy. Users can enter any other amount. | Any positive number. Min/max will be validated upon widget load.
Stablecoin Min >= 10
Non-Stablecoin Min >= 25 | String | |
offPayAmount The amount that will be entered by default for the user to sell. Users can enter any other amount. | Any positive number. Min/max will be validated upon widget load. | String | |
onToAddress Blockchain address of the wallet where the purchased cryptocurrency will be sent to. | Valid wallet address matching the network
Ex: 0x3ACfa4b5320550199C322A9B33e85c70d0F90D1b | String | |
onToAddressMulti
Key-value pairs to set multiple wallet addresses, associated to a specific blockchain. | Valid chain:address key-value pairs
Ex:
ETHEREUM:0x1234,OSMOSIS:osmo1234,COSMOS HUB:cosmos1234 | Array[string] | |
offFromAddress
Blockchain address of the wallet that cryptocurrency will be sent from, for an off-ramp. | Valid wallet address matching the network
Ex: 0x3ACfa4b5320550199C322A9B33e85c70d0F90D1b | String | |
network The crypto network that will be selected by default for buy or sell. Users can select any other networks that are available for selection. Note: Requires onRevCurrency to be set.
Note: Off Ramp currently not available for Arbitrum, Optimism, Polygon | BITCOIN, TERRA, OSMOSIS, SOLANA, ETHEREUM, JUNO, AVALANCHE, KUJIRA, INJECTIVE, ARBITRUM, OPTIMISM, POLYGON, COSMOS HUB, STELLAR, STARGAZE, SECRET, BASE, COMDEX, RIPPLE, BASE, REGEN, AGORIC, MIGALOO, KI, XPLA, NOBLE | String | |
cryptoList
A comma-separated list of crypto currencies that users can buy or sell. Only these will show on the widget. | USDT, USDC, SOL, ETH, AVAX, DAI, OSMO, ATOM, BTC, XLM, STARS, SCRT, INJ, CMDX, wETH, wBTC, USDC.e, MATIC, XRP, REGEN, WHALE, BLD, IST, XKI, XPLA | Array[string] | USDT, USDC, SOL, ETH, AVAX, DAI, OSMO, ATOM, BTC, XLM, STARS, SCRT, INJ, CMDX, wETH, wBTC, USDC.e, MATIC, XRP, REGEN, WHALE, BLD, IST, XKI, XPLA |
fiatList
A comma-separated list of fiat currencies that users can buy or sell. Only these will show on the widget. | USD, CAD, GBP, EUR, MXN, COP, INR, CHF, AUD, ARS, BRL, CLP, JPY, KRW, PEN, PHP, SGD, TRY, UYU, TWD, VND, CRC, SEK, PLN, DKK, NOK, NZD | Array[string] | USD, CAD, GBP, EUR, MXN, COP, INR, CHF, AUD, ARS, BRL, CLP, JPY, KRW, PEN, PHP, SGD, TRY, UYU, TWD, VND, CRC, SEK, PLN, DKK, NOK, NZD |
networkList A comma-separated list of crypto networks that users can buy or sell. Only these will show on the widget. Note: Requires onRevCurrency to be set. | BITCOIN, TERRA, OSMOSIS, SOLANA, ETHEREUM, JUNO, AVALANCHE, KUJIRA, INJECTIVE, ARBITRUM, OPTIMISM, POLYGON, COSMOS HUB, STELLAR, STARGAZE, SECRET, BASE, COMDEX, RIPPLE, BASE, REGEN, AGORIC, MIGALOO, KI, XPLA, NOBLE | Array[string] | BITCOIN, TERRA, OSMOSIS, SOLANA, ETHEREUM, JUNO, AVALANCHE, KUJIRA, INJECTIVE, ARBITRUM, OPTIMISM, POLYGON, COSMOS HUB, STELLAR, STARGAZE, SECRET, BASE, COMDEX, RIPPLE, BASE, REGEN, AGORIC, MIGALOO, KI, XPLA, NOBLE |
productList
A comma-separated list of products that the user will see on the widget. | BUY, SELL, SWAP | Array[string] | BUY, SELL, SWAP |
theme
Sets the theme of the widget to light or dark. The default theme is light. | light, dark | String | light |
email
The user's email that you'd like to trigger a login for | valid email address | String | |
mode
The UI mode. Minimal mode will remove the menu and drop users directly into the Order Confirmation page. | minimal, full | String | |
fiatMethodList
The fiat payment methods to allow the user to pay with, or sell to. | card, ach, apple, wire, sepa | Array[string] | card, ach, apple, wire, sepa |
userRef
An optional reference provided by the integrator to link a reference in the integrator's system to a Kado user. | valid uuid | String | |