Query Parameters

Customize On-Ramp, Off-Ramp, and NFT Checkout experiences with query parameters

OZZOBiT widgets can be customized using URL query parameters. These parameters allow you to control the appearance, default values, user data, and behavior of the widget without writing any code.

Overview

Parameters are appended to the base widget URL:

texttext

https://OZZOBiT.com/global?apiKey=YOUR_KEY&param1=value1&param2=value2

ℹ️

Quick Example

curl "https://OZZOBiT.com/global?apiKey=YOUR_KEY&defaultCryptoCurrency=ETH&walletAddress=0x..."

apiKeystringrequired

Your public API key from the Partner Dashboard. This is the only required parameter.

environmentstringDefault: PRODUCTION

Set to 'STAGING' for sandbox testing or 'PRODUCTION' for live transactions.

themeColorstring

Primary color of the widget in hex format (e.g., #1461db). Affects buttons, links, and accent elements.

hostLogoURLstring

URL of your logo displayed in the widget header. Recommended size: 200x40px.

hostURLstring

URL of your website shown in the widget footer as "Powered by" link text.

hostURLNamestring

Display name for your host URL shown in the footer.

defaultNetworkstring

Default blockchain network (e.g., ethereum, polygon, bsc).

defaultCryptoCurrencystring

Default cryptocurrency selected on load (e.g., ETH, BTC, MATIC).

defaultFiatCurrencystring

Default fiat currency (e.g., USD, EUR, GBP).

fiatAmountnumber

Pre-fill fiat amount field with a specific value.

cryptoAmountnumber

Pre-fill crypto amount field with a specific value.

isDisableCryptoAmountbooleanDefault: false

Disable editing of crypto amount field when fiatAmount is set.

isDisableFiatAmountbooleanDefault: false

Disable editing of fiat amount field when cryptoAmount is set.

networksstring

Comma-separated list of allowed networks (e.g., ethereum,polygon,bsc). Limits network selection.

cryptoCurrencyListstring

Comma-separated list of allowed cryptocurrencies (e.g., ETH,BTC,MATIC,USDT).

fiatCurrencyListstring

Comma-separated list of allowed fiat currencies (e.g., USD,EUR,GBP).

walletAddressstring

Pre-filled destination wallet address for crypto purchases. User can change this unless locked.

disableWalletAddressFormbooleanDefault: false

Lock the wallet address so users cannot modify it.

emailstring

Pre-fill user email address for Auth Reliance.

firstNamestring

User's first name passed for Auth Reliance.

lastNamestring

User's last name passed for Auth Reliance.

phoneNumberstring

User's phone number in E.164 format (+14155551234) for Auth Reliance.

userIdstring

Your internal user ID for reference and tracking.

countryCodestring

ISO 3166-1 alpha-2 country code (e.g., US, GB) to pre-select user's country.

hideMenubooleanDefault: false

Hide the menu button in the widget header.

hideMenuBarbooleanDefault: false

Hide the entire menu bar / header area.

productsAvailedstringDefault: BUY

Product to show: BUY (on-ramp), SELL (off-ramp), or NFT.

redirectURLstring

URL to redirect users after transaction completion (redirection mode only). Status parameters are appended.

partnerOrderIdstring

Your reference ID for the order, returned in webhooks and API responses.

exchangeScreenTitlestring

Custom title text shown on the exchange/purchase screen.

promoCodestring

Promotional/discount code applied automatically.

paymentAttemptstring

Track payment attempts for analytics (less_than_5, etc.).

quoteCountryCodestring

Override country for quote pricing (see guide).

disableSearchbooleanDefault: false

Hide the cryptocurrency search bar.

isAutoFillUserDatabooleanDefault: true

Auto-populate user data fields from previous sessions.

productsAvailedstringrequired

Must be set to NFT for NFT Checkout mode.

nftCheckoutDataobject (JSON stringified)

JSON object containing NFT purchase details including contract address, token ID, network, and calldata.

nftContractAddressstring

Smart contract address of the NFT collection.

nftTokenIdstring

Token ID of the NFT being purchased.

nftNetworkstring

Blockchain network where the NFT resides (ethereum, polygon, etc.).

nftPricenumber

Fixed price of the NFT in the smallest currency unit (e.g., wei for ETH-based chains).

nftQuantitynumberDefault: 1

Number of NFT copies to purchase (for ERC-1155).

walletAddressstring

Destination wallet address where the purchased NFT will be delivered.

defaultFiatCurrencystring

Default fiat currency for pricing display.

defaultPaymentMethodstring

Default payment method (credit_debit_card, bank_transfer, etc.).

disablePaymentMethodsstring

Comma-separated list of payment methods to hide.

emailstring

Buyer's email address for order confirmation and KYC.

firstNamestring

Buyer's first name.

lastNamestring

Buyer's last name.

countryCodestring

Buyer's country code.

partnerOrderIdstring

Your internal reference for this NFT purchase.

affiliateClientIdstring

Affiliate tracking ID.

utmSourcestring

UTM source parameter for analytics.

utmMediumstring

UTM medium parameter.

utmCampaignstring

UTM campaign parameter.

themeColorstring

Primary theme color in hex format.

hostLogoURLstring

Your logo URL for widget branding.

hideMenubooleanDefault: false

Hide menu button.

hideMenuBarbooleanDefault: false

Hide entire header/menu bar.

exchangeScreenTitlestring

Custom screen title.

screenBackgroundColorstring

Background color of the widget.