NFT Checkout Widget Customization

The FaTPay widget could be customized by passing query parameters. The following parameters empower our partners to tailor the user experience according to their businesses.

All keys and values of parameters are case-sensitive. All values' format is String.

Parameters for all pages

language

  • Description: Language code chosen from [Languages] for FaTPay widget, e.g. language=en;

  • Default: en;

  • Scope: Applicable for all partners;

  • Required: Optional for all partners;

  • Signed: Not required to sign;

Parameters for quotation page

contractAddress

  • Description: NFT contract address, e.g. contractAddress=0x407c5d2c02ab0e4b0a98d14778a5de180eb1357f.

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

nftNetwork

  • Description: The chain to which the NFT contract belongs, ethereum / polygon / bsc / optimism / arbitrum / avalanche / fantom / celo / harmony, Other chains can contact us, e.g. nftNetwork=ethereum.

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

tokenId

  • Description: NFT's tokenID, e.g. tokenId=245.

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for type=MARKET;

  • Signed: Mandatory to sign;

merchantUniqueId

  • Description: NFT unique identification in your marketplace, e.g. merchantUniqueId=8888888888.

  • Scope: Applicable for Premium Partners;

  • Required: Optional for Premium Partners;

  • Signed: Mandatory to sign;

type

  • Description: MARKET or MINT, e.g. type=MARKET.

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

mintQuantity

  • Description: Mint quantity, e.g. mintQuantity=1.

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for type=MINT;

  • Signed: Mandatory to sign;

ownerWalletAddress

  • Description: NFT current holder wallet address, e.g. ownerWalletAddress=0x407c5d2c02ab0e4b0a98d14778a5de180eb1367f.

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for type=MARKET;

  • Signed: Mandatory to sign;

transferWalletAddress

  • Description: After payment, the wallet address of the NFT transfer, e.g. transferWalletAddress=0x1D894C1D34B462796c6f43A9d086C9F175CCb422.

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

cryptoCurrency

  • Description: Cryptocurrency codes chosen from [ Cryptocurrencies (NFT Checkout) ] for NFT's price, e.g. cryptoCurrency=USDT_ERC20

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

amount

  • Description: Cryptocurrency amount for NFT's price, e.g. cryptoCurrency=USDT_ERC20&amount=200

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

walletAddress

  • Description: Wallet address for cryptocurrency settlement, e.g. walletAddress=0x2D463C1D34B462796c6f43A9d086C9F175CCb488

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

walletAddressTag

  • Description: Wallet address tag for cryptocurrency settlement (Only Tag/Memo supported for public chains that support this parameter, such as ATOM.), e.g. walletAddressTag=88888

  • Scope: Applicable for Premium Partners;

  • Required: Mandatory for Premium Partners;

  • Signed: Mandatory to sign;

merchantOrderNo

  • Description: Order number in your marketplace, e.g. merchantOrderNo=88888888888888.

  • Scope: Applicable for Premium Partners;

  • Required: Optional for Premium Partners;

  • Signed: Mandatory to sign;

externalCustomerId

  • Description: Customer ID in your marketplace, e.g. externalCustomerId=88888888888888.

  • Scope: Applicable for Premium Partners;

  • Required: Optional for Premium Partners;

  • Signed: Mandatory to sign;

fiatCurrency

  • Description: Fiat currency codes chosen from [Fiat Currencies] for FaTPay widget to provide a list of selected fiat currencies to the user. Multiple currency codes should be concatenated with comma as separator, e.g. fiatCurrency=USD,THB. Then user can only pay in USD or THB;

  • Default: All available fiat currencies;

  • Scope: Applicable for all partners;

  • Required: Optional for all partners;

  • Signed: Not required to sign;

defaultFiatCurrency

  • Description: Fiat currency code chosen from [Fiat Currencies] for FaTPay widget to display default fiat currency to the user, e.g. defaultFiatCurrency=USD. Then USD is selected as default fiat currency;

  • Default: USD. If fiatCurrency is set, then it's the first fiat currency code;

  • Scope: Applicable for all partners;

  • Required: Optional for all partners;

  • Signed: Not required to sign;

Parameters for sign up/in page

email

  • Description: Fill in the email address for user on FaTPay widget. Email address field will be left empty if the format validation of email address is failed. E.g. [email protected];

  • Default: None;

  • Scope: Applicable for all partners;

  • Required: Optional for all partners;

  • Signed: Not required to sign;

Misc parameters

windowOpen

  • Description: It's suggested to append this parameter to get rid of 403 Forbidden iframe error, e.g. windowopen=1;

  • Default: 0;

  • Scope: Applicable for all partners;

  • Required: Optional for all partners;

  • Signed: Not required to sign;

ext

  • Description: Extended fields;

  • Default: None;

  • Scope: Applicable for all partners;

  • Required: Optional for all partners;

  • Signed: Mandatory to sign for Premium Partners. Should be urlencoded before sign;

PreviousOn-ramp Widget CustomizationNextInterface Customization

Last updated