🛠️Widget Configuration Parameters
You may use these parameters in your URL to further customize your Widget
Core Parameters
These are the minimum configuration values required to embed and initialize the widget.
Tip: These values help Coindisco render the correct version of your widget for the right audience and context.
publicKey
string
required
Identifier for your widget instance. You get it from Coindisco. Used for tracking transactions.
environment
string
optional
Defines environment: production
(default) or staging
.
operationMode
string
optional
Defines available transaction types buy
(default), sell
, buy_sell
Transaction Defaults:
Use these parameters to pre-fill what the user will see when the widget loads — like currency, crypto, network, amount, and wallet address.
Tip: Use lockDefaultAsset for campaigns or integrations where only one token should be offered.
defaultAsset
string
optional
Token to purchase by default (e.g., btc
, eth
). Defaults to btc
in bitcoin
network.
defaultFiat
string
optional
Default fiat currency (e.g., USD
, EUR
). Defaults by user region — not recommended to override.
defaultFiatAmount
number
optional
Amount in fiat to pre-fill. Defaults to 100 USD
converted to the user's regional fiat.
defaultNetwork
string
optional
Blockchain network (e.g., bitcoin
, ethereum
). Defaults to bitcoin
if not provided.
defaultPaymentMethod
string
optional
Payment method pre-selected for the user. Defaults by region; falls back to debit card.
lockDefaultAsset
boolean
optional
If true
, prevents users from selecting any other crypto asset.
walletAddress
string
optional
Wallet address of the user for the chosen defaultNetwork
. If not set, input form is shown.
wallets
string
optional
Comma-separated list of wallets across networks (for multi-chain wallets or platforms).
Providers & Availability (Lists)
Control which networks, tokens, fiats, and payment providers are visible.
include* → shows only the listed items.
exclude* → hides the listed items from the full set.
All values are comma-separated lists.
activeProviders
string
optional
List of enabled payment providers.
excludeCrypto
string
optional
List of crypto assets to hide.
excludeFiats
string
optional
List of fiat currencies to hide.
excludePaymentMethods
string
optional
List of payment methods to hide.
includeCrypto
string
optional
List of crypto assets to explicitly show.
includeFiats
string
optional
List of fiat currencies to explicitly show.
includePaymentMethods
string
optional
List of payment methods to explicitly show.
supportedNetworks
string
optional
List of blockchain networks (e.g., ethereum,solana
). Restricts token set.
Theme & Style:
Make the widget match your brand using a wide range of visual customization options. All colors are passed as HEX codes (e.g. #1a1a1a or #ffffff).
Tip: These parameters give you pixel-level control over how the widget blends into your UI.
Notes:
`theme` can be `light`, `dark`, or any custom preset from the Customizer. Defaults to the user's system theme.
All color values must be in HEX format without the
#
sign.
theme
string
optional
UI theme: light
, dark
, cyberpunk
, etc.
backgroundCard
string
optional
Background of card elements.
backgroundColor
string
optional
General widget background.
borderColor
string
optional
Border color of elements.
buttonBackground
string
optional
Primary button background.
errorColor
string
optional
Error messages or error states.
hoverColor
string
optional
Hover/focus color for buttons and inputs.
iconsColor
string
optional
Icon color.
invertTextColor
string
optional
Text color for dark backgrounds.
secondTextColor
string
optional
Secondary text color.
skeletonGradientFrom
string
optional
Start color of skeleton loading gradient.
skeletonGradientTo
string
optional
End color of skeleton loading gradient.
successColor
string
optional
Success states (e.g., after transaction).
textColor
string
optional
Main text color.
Final Integration:
When you finish configuring parameters (or using the Customizer ), you'll get the final URLs:
widgetUrl
string
output
Final URL of the widget to embed in your app.
customizeUrl
string
output
Link to the Customizer with your parameters.
Last updated