Parameters for Hosted Checkout

Hosted Checkout parameters are values that can be included within the URL of your Hosted Checkout page. You can use these parameters to add, update, and customize fields on the page.

👍

Using Hosted Checkout parameters

For a short video on how to use Hosted Checkout parameters, click here.

📘

Override price

If you would like to override the price that appears on the checkout page, use the override price capability, which is based on an encrypted parameter.

Hosted Checkout general parameters

Some of the frequently used parameters include:

  • Use the quantity parameters to display the number of units of a given contract to add to the order
  • Use the store id parameter to dynamically assign a specific template associated with the merchant
  • Use the coupon code parameter to pre-populate the coupon code field with the relative code
  • Use the promotion parameters to add additional items to the order page
ParameterTypeDescription
autosubmitY/NAutomatically selects all the default values on the page and then automatically submits the page. Only functions if all of the following apply:
All the mandatory fields (required for the selected payment method) are supplied and valid
There are no errors in the page
* No mandatory checkbox for shopper consent appears in the page
backtosellervisibleY/NDefines whether the "Continue" button appears on the Thank You page
browsertitlestringDefines the title of the browser page, which appears in the browser tab
Example: Checkout
browsertitlevisibleY/NDefines whether the title of the browser page is visible
cart.openY/NWhen set to Y, the cart on the mobile skin is expanded by default upon loading
cartvisibleY/NIndicates if the shopping cart is visible. Y=visible (default: Y)
companylogovisibleY/NDefines whether the company logo is visible
couponboxvisibleY/NIndicates if the coupon code/gift certificate box is visible. Y=visible (default: Y, if the shopper is allowed to add an additional coupon)
couponcodestringCoupon to be used in the purchase
Example: CYBERMONDAY
currency3-letter ISO-4217 code
(case-insensitive)
Currency to display on the order page
Example: EUR
currencyvisibleY/NIndicates if the shopper currency preference field is visible. Y=visible (default: Y)
currencydisableY/NIndicates if the shopper currency preference field is disabled. Y=disabled (default: N)
custom[#]stringSets the value for a specified custom parameter. Value depends on the custom parameter's type (i.e. text box, checkbox, dropdown).
Example:
text box, dropdown
custom1=someText
checkbox
custom2=Y
custom3=N
custom[#].sku.[contract ID]stringSets the value for the specified custom parameter, for the specified contract only
Example: custom.4903.sku.2131313=’Red’
edwvisibleY/NIndicates if the EDW component is visible
forceDesktopY/NIndicates whether to force the desktop skin to display, regardless of the shopper's device
forceMobileY/NIndicates whether to force the mobile skin to display, regardless of the shopper's device
languagestringLanguage
Possible values:
  ALBANIAN
  ARABIC
  BRAZILIAN
  BULGARIAN
  CZECH
  DANISH
  DUTCH
  ENGLISH
  FINNISH
  FRENCH
  GERMAN
  HEBREW
  HUNGARIAN
  ITALIAN
  JAPANESE
  KOREAN
  LITHUANIAN
  NORWEGIAN
  POLISH
  PORTUGUESE
  RUSSIAN
  SERBIAN
  SLOVAK
  SPANISH
  SWEDISH
  TURKISH
languagevisibleY/NIndicates if the shopper language preference field is visible. Y=visible (default: Y)
languagedisableY/NIndicates if the shopper language preference field is disabled. Y=disabled (default: N)
promotionsvisibleY/NIndicates if promotional items are visible (default: Y, if promotional items exist)
quantitydisableY/NAllows you to disable the quantity selection menu (default: N)
referrerintegerFor affiliation: the affiliate ID
Example: 123585
scidintegerShopping context ID
Example: 12344542
sealmcafeevisibleY/NDefines whether the McAfee secure seal is visible
sealverisignvisibleY/NDefines whether the Verisign secure seal is visible
sealvisibleY/NDefines whether the secure seal is visible
sellerorderid
or
seller.order.id
stringUnique ID that the merchant assigns to the transaction/order, up to 50 characters
Example: 1000
shoppingcarttotalvisibleY/NIndicates if the shopping cart total is visible. Y=visible (default: Y)
showupsalepricesY/NIndicates if sale prices display (default: Y)
skinIdintegerID of the skin to apply to the page
Example: 11003
sku[contractID]=#integerQuantity of the item (or promotional item) to be purchased
Example: sku123456=3
sku[contract ID]aldY/NY=Allow the shopper to remove this SKU from the cart's promotional items (default)

N – Remove the delete item button from the order page
Example: sku1666864ald=N
sku[contract ID]namestringOverride this SKU to have the name given as the parameter value.
Example: sku1471485name=cocacola
skuimagevisibleY/NDefines whether the contract's image is visible
softdescstringSoft descriptor that should appear on the shopper’s card bill
Example: Pizza House Inc.
storecardvisibleY/NDefines whether the Securely store card for recurring payments option is visible
Default=Y
storeidintegerStore ID
Example: 155
submitvisibleY/NIndicates whether the submit button is visible
testModeY/NIndicates whether this is a test of the flow
tidstringFor affiliation: the transaction ID
Example: 12345
upsalevisibleY/NIndicates if the up sales component is visible. Y=visible (default: Y, if up sales items exist)

Payment options

You can use Hosted Checkout parameters to perform useful tasks, such as:

📘

Payment methods must be enabled in the Merchant Portal

Before the following payment option parameters can be used, the payment methods you intend to use must be enabled to “Show” in the Merchant Portal. For example, if you want to use the paymentecp parameter, ECP must be enabled for your account.

Hiding payment methods

You can use these parameters to hide (or disable) specific payment methods.

ParameterTypeDescription
payment[paymentMethod]Y/NIndicates if the specified payment method is visible in "Payment Options" section

Payment method available values:
  alipay
  banktransfer
  boletoBancario
  cc
  ecp
  moneybookers
  paypal
  paysafecard
  realtimebank
  sepadd
  skrill
  webmoney
  wire

Example:
paymentcc=N
paymentpaypal=N
paymentwire=N
paymentmethodsvisibleY/NIndicates if the payment options widget is visible
alipayY/NIndicates if Alipay is visible in the "Payment Options" section
banktransferY/NIndicates if Bank Transfer is visible in the "Payment Options" section
boletoBancarioY/NIndicates if Boleto Bancario is visible in the "Payment Options" section
ecpY/NIndicates if ECP is visible in the "Payment Options" section
ccY/NIndicates if Credit Cards is visible in the "Payment Options" section
paypalY/NIndicates if PayPal is visible in the "Payment Options" section
skrillY/NIndicates if Skrill (aka. Moneybookers) is visible in the "Payment Options" section
moneybookersY/NIndicates if Moneybookers (aka. Skrill) is visible in the "Payment Options" section
webmoneyY/NIndicates if WebMoney is visible in the "Payment Options" section
wireY/NIndicates if Wire is visible in the "Payment Options" section
paysafecardY/NIndicates if paysafe is visible in the "Payment Options" section
realtimebankY/NIndicates if real time bank transfer is visible in the "Payment Options" section
ccnumbervisibleY/NIndicates if the CC number field is visible (default: Y)
cctypevisibleY/NIndicates if the CC type field is visible (default: Y)
cctypedisableY/NIndicates if the CC type field is disabled. Y=disabled (default: N)
ccdatevisibleY/NIndicates if the CC expiration date field is visible (default: Y)
ccdatedisableY/NIndicates if the CC expiration date field is disabled. Y=disabled (default: N)
expirationmonthintegerCC expiration month
Example: 12
expirationyearintegerCC expiration year
Example: 2019
ccstartdatevisibleY/NIndicates if the CC start date field is visible (default: Y, if start date is applicable for the selected CC type)
ccstartdatedisableY/NIndicates if the CC start date field is disabled. Y=disabled (default: N)
ccstartmonthintegerCC start month
Example: 09
ccstartyearintegerCC start year
Example: 2015
cccodevisibleY/NIndicates if the CC security code field is visible (default: Y, if start date is applicable for the selected CC type)
cccodedisableY/NIndicates if the CC security code field is disabled. Y=disabled (default:N)

Pre-selecting a payment method

You can use the following parameter to pre-select a payment method for your shopper on the checkout page.

ParameterTypeDescription
selectedPaymentMethodStringSpecifies the default selected payment method when the shopper sees the checkout page.

Available values:
  ALIPAY
  APPLE_PAY
  BANKTRANSFER
  BOLETO_BANCARIO
  CC
  ECP
  ENETS
  GIROPAY
  IDEAL
  MONEYBOOKERS
  PAYPAL
  PAYSAFECARD
  SEPA_DIRECT_DEBIT
  SOFORTUBERWEISUNG
  WALLET_MP
  WALLET_VISA
  WEBMONEY
  WIRE

Example:
selectedPaymentMethod=PAYPAL
selectedPaymentMethod=SEPA_DIRECT_DEBIT

Billing information

You can use these parameters to pre-populate billing detail fields on the checkout page, and to customize which options appear.

ParameterTypeDescription
billingfirstnamestringFirst name
Example: John
billinglastnamestringLast name
Example: Doe
billingfullNamestringFull billing name
Example: JohnDoe
billingaddress1stringAddress line 1
Example: 1234 St. James Dr.
billingaddress2stringAddress line 2
Example: Suite 123
billingcitystringCity
Example: San Diego
billingstatestringState
Example: CA
billingzipcodestringZIP code or postal code
Example: 78467
billinginfocheckboxvisibleY/NIndicates if the billing info check box is visible. Y=visible (default: N)
billinginfovisibleY/NIndicates if the billing info widget is visible. Y=visible (default: N - As default, it is shown only if the shopper checks the billing info checkbox)
billinginfodisableY/NIndicates if the billing info widget is disabled. Y=disabled (default: N)
billingfullnamevisibleY/NIndicates if the billing full name field is visible. Y=visible (default: Y)
billingfullnamedisableY/NIndicates if the billing full name field is disabled. Y=disabled (default: N)
billingfirstnamevisibleY/NIndicates if the billing first name field is visible. Y=visible (default: Y)
billingfirstnamedisableY/NIndicates if the billing first name field is disabled. Y=disabled (default: N)
billinglastnamevisibleY/NIndicates if the billing last name field is visible. Y=visible (default: Y)
billinglastnamedisableY/NIndicates if the billing last name field is disabled. Y=disabled (default: N)
billingaddress1visibleY/NIndicates if the billing address 1 field is visible. Y=visible (default: Y)
billingaddress1disableY/NIndicates if the billing address 1 field is disabled. Y=disabled (default: N)
billingaddress2visibleY/NIndicates if the billing address 2 field is visible. Y=visible (default: N)
billingaddress2disableY/NIndicates if the billing address 2 field is disabled. Y=disabled (default: N)
billingcityvisibleY/NIndicates if the billing city field is visible. Y=visible (default: Y)
billingcitydisableY/NIndicates if the billing city field is disabled. Y=disabled (default: N)
billingzipvisibleY/NIndicates if the billing zip code field is visible. Y=visible (default: Y)
billingzipdisableY/NIndicates if the billing zip code field is disabled. Y=disabled (default: N)
billingcountryvisibleY/NIndicates if the billing country field is visible. Y=visible (default: Y)
billingcountrydisableY/NIndicates if the billing country field is disabled. Y=disabled (default: N)
billingstatevisibleY/NIndicates if the billing state field is visible. Y=visible (default: Y, but only if relevant by the selected country)
billingstatedisableY/NIndicates if the billing state field is disabled. Y=disabled (default: N)

Shipping information

You can use these parameters to pre-populate shipping detail fields on the checkout page, and to customize which options appear.

📘

Note

Shipping information fields are displayed on the checkout page if the 'Collect Shipping Address' option is enabled in the contract's settings (under General Settings > Miscellaneous).

ParameterTypeDescription
shippingfirstnamestringFirst name
Example: John
shippinglastnamestringLast name
Example: Doe
shippingfullNamestringFull name
Example: JohnDoe
shippingaddress1stringAddress line 1
Example: 1234 St. James Dr.
shippingaddress2stringAddress line 2
Example: Suite 123
shippingcitystringCity
Example: San Diego
shippingstatestringState
Example: CA
shippingzipcodestringZIP code or postal code
Example: 78467
shippingcountry2-letter ISO_3166-1 codeCountry
Example: US
shippinginfocheckboxvisibleY/NIndicates if the shipping info checkbox is visible. Y=visible (default: N)
shippinginfovisibleY/NIndicates if the shipping info widget is visible. Y=visible (default: N - As default, it is shown only if the shopper checks the shipping info checkbox)
shippinginfodisableY/NIndicates if the shipping info widget is disabled. Y=disabled (default: N)
shippingfirstnamevisibleY/NIndicates if the shipping first name field is visible. Y=visible (default: Y)
shippingfirstnamedisableY/NIndicates if the shipping first name field is disabled. Y=disabled (default: N)
shippinglastnamevisibleY/NIndicates if the shipping last name field is visible. Y=visible (default: Y)
shippinglastnamedisableY/NIndicates if the shipping last name field is disabled. Y=disabled (default: N)
shippingfullnamevisibleY/NIndicates if the shipping full name field is visible. Y=visible (default: Y)
shippingfullnamedisableY/NIndicates if the shipping full name field is disabled. Y=disabled (default: N)
shippingaddress1visibleY/NIndicates if the shipping address 1 field is visible. Y=visible (default: Y)
shippingaddress1disableY/NIndicates if the shipping address 1 field is disabled. Y=disabled (default: N)
shippingaddress2visibleY/NIndicates if the shipping address 2 field is visible. Y=visible (default: N)
shippingaddress2disableY/NIndicates if the shipping address 2 field is disabled. Y=disabled (default: N)
shippingcityvisibleY/NIndicates if the shipping city field is visible. Y=visible (default: Y)
shippingcitydisableY/NIndicates if the shipping city field is disabled. Y=disabled (default: N)
shippingzipvisibleY/NIndicates if the shipping zip code field is visible. Y=visible (default: Y)
shippingzipdisableY/NIndicates if the shipping zip code field is disabled. Y=disabled (default: N)
shippingcountryvisibleY/NIndicates if the shipping country field is visible. Y=visible (default: Y)
shippingcountrydisableY/NIndicates if the shipping country field is disabled. Y=disabled (default: N)
shippingstatevisibleY/NIndicates if the shipping state field is visible. Y=visible (default: Y, but only if relevant for the selected country)
shippingstatedisableY/NIndicates if the shipping state field is disabled. Y=disabled (default: N)

Invoice information

You can use these parameters to pre-populate invoice detail fields on the checkout page, and to customize which options appear.

ParameterTypeDescription
invoiceinfocheckboxvisibleY/NIndicates if the invoice checkbox is visible. Y=visible
invoiceinfovisibleY/NIndicates if the invoice info is visible. Y=visible
invoiceinfodisableY/NIndicates if the invoice info is disabled. Y=disabled
invoiceaddress1stringAddress line 1 on the invoice
Example: 1234 St. James Dr.
invoiceaddress1visibleY/NIndicates if the address 1 field is visible. Y=visible
invoiceaddress1disableY/NIndicates if the address 1 field is disabled. Y=disabled
invoiceaddress2stringAddress line 2 on the invoice
Example: Suite 100
invoiceaddress2visibleY/NIndicates if the address 2 field is visible. Y=visible
invoiceaddress2disableY/NIndicates if the address 2 field is disabled. Y=disabled
invoicecitystringCity on the invoice
Example: San Diego
invoicecityvisibleY/NIndicates if the city field is visible. Y=visible
invoicecitydisableY/NIndicates if the city field is disabled. Y=disabled
invoicecompanynamestringCompany name on the invoice
Example: Acme
invoicecompanynamevisibleY/NIndicates if the company name field is visible. Y=visible
invoicecompanynamedisableY/NIndicates if the company name field is disabled. Y=disabled
invoicecountry2-letter ISO_3166-1 codeCountry on the invoice
Example: US
invoicecountryvisibleY/NIndicates if the country field is visible. Y=visible
invoicecountrydisableY/NIndicates if the country field is disabled. Y=disabled
invoiceemailstringEmail on the invoice
Example: [email protected]
invoiceemailvisibleY/NIndicates if the email field is visible. Y=visible
invoiceemaildisableY/NIndicates if the email field is disabled. Y=disabled
invoicefirstNamestringFirst name on the invoice
Example: John
invoicefirstnamevisibleY/NIndicates if the first name field is visible. Y=visible
invoicefirstnamedisableY/NIndicates if the first name field is disabled. Y=disabled
invoicefullNamestringFull name on the invoice
Example: John Doe
invoicefullnamevisibleY/NIndicates if the full name field is visible. Y=visible
invoicefullnamedisableY/NIndicates if the full name field is disabled. Y=disabled
invoicelastNamestringLast name on the invoice
Example: Doe
invoicelastnamevisibleY/NIndicates if the last name field is visible. Y=visible
invoicelastnamedisableY/NIndicates if the last name field is disabled. Y=disabled
invoicestatestringState on the invoice
Example: CA
invoicestatevisibleY/NIndicates if the state field is visible. Y=visible
invoicestatedisableY/NIndicates if the state field is disabled. Y=disabled
invoicetitlestringTitle on the invoice
Example: Mr
invoicetitlevisibleY/NIndicates if the title field is visible. Y=visible
invoicetitledisableY/NIndicates if the title field is disabled. Y=disabled
invoiceworkphonestringWork phone number on the invoice
Example: 800-123-4567
invoicephonevisibleY/NIndicates if the phone number field is visible. Y=visible
invoicephonedisableY/NIndicates if the phone number field is disabled. Y=disabled
invoicezipcodestringZIP code on the invoice
Example: 01234
invoicezipvisibleY/NIndicates if the ZIP code field is visible. Y=visible
invoicezipdisableY/NIndicates if the ZIP code field is disabled. Y=disabled

Shopper information

You can use these parameters to pre-populate shopper information fields on the checkout page, and to customize which options appear.

ParameterTypeDescription
titlestringTitle
Example: Mr
companynamestringCompany name
Example: Best Company
firstnamestringFirst name
Example: John
lastnamestringLast name
Example: Doe
fullnamestringFull name
Example: John Doe
emailstringEmail
Example: [email protected]
address1stringAddress line 1
Example: 1234 St. James Dr.
address2stringAddress line 2
Example: Suite 123
citystringCity
Example: San Diego
statestringState
Example: CA
country2-letter ISO_3166-1 codeCountry
Example: US
zipstringZIP code or postal code
Example: 78467
workphonestringWork phone number
Example: 3456789123
faxnumberstringFax number
Example: 9876543333
personalIdstringPersonal identification number for shoppers in these countries: Argentina (DNI), Brazil (CPF/CNPJ), Chile (RUN), and Mexico (CURP/RFC)
Example: personalId=61.384.546/0001-88
shoppersprefvisibleY/NIndicates if the shopper language and currency preference fields are visible. Y=visible (default: Y)
shoppersprefdisableY/NIndicates if the shopper language and currency preference fields are disabled. Y=disabled (default: N)
shopperinfovisibleY/NIndicates if the shopper information fields are visible. Y=visible (default: Y)
shopperinfodisableY/NIndicates if the shopper information fields are disabled. Y=disabled (default:N)
accountdetailsinfovisibleY/NIndicates if the shopper account details are visible. Y=visible
companynamevisibleY/NIndicates if the company name field is visible. Y=visible (default: N)
companynamerequireY/NIndicates if the company name field is mandatory. (default: N)
companynamedisableY/NIndicates if the company name field is disabled. Y=disabled (default: N)
titlevisibleY/NIndicates if shopper's title field is visible. Y=visible (default: N)
titlerequireY/NIndicates if shopper title is mandatory. (default: N)
titledisableY/NIndicates if shopper title field is disabled. Y=disabled (default: N)
firstnamevisibleY/NIndicates if shopper first name field is visible. Y=visible (default: Y)
firstnamedisableY/NIndicates if the shopper first name field is disabled. Y=disabled (default: N)
lastnamevisibleY/NIndicates if shopper last name field is visible. Y=visible (default: Y)
lastnamedisableY/NIndicates if the shopper last name field is disabled. Y=disabled (default: N)
fullnamevisibleY/NIndicates if shopper full name field is visible. Y=visible (default: Y)
fullnamedisableY/NIndicates if the shopper full name field is disabled. Y=disabled (default: N)
emailvisibleY/NIndicates if the shopper email field is visible. Y=visible (default: Y)
address1visibleY/NIndicates if the address line 1 field is visible. Y=visible (default: Y)
address1disableY/NIndicates if the address line 1 field is disabled. Y=disabled (default: N)
address2visibleY/NIndicates if the address line 2 field is visible. Y=visible (default: N)
address2requireY/NIndicates if the address line 2 field is mandatory. (default: N)
address2disableY/NIndicates if the address line 2 field is disabled. Y=disabled (default: N)
cityvisibleY/NIndicates if the city field is visible. Y=visible (default: Y)
citydisableY/NIndicates if the city field is disabled. Y=disabled
zipvisibleY/NIndicates if the ZIP code field is visible. Y=visible (default: Y)
zipdisableY/NIndicates if the ZIP code field is disabled. Y=disabled (default: N)
countryvisibleY/NIndicates if the shopper’s country field is visible. Y=visible (default: Y)
countrydisableY/NIndicates if the shopper’s country field is disabled. Y=disable (default:N)
statevisibleY/NIndicates if the shopper’s state field is visible. Y=visible (default: Y, but only if relevant for the selected country)
statedisableY/NIndicates if the shopper’s state field is disabled. Y=disabled (default: N)
phonevisibleY/NIndicates if the shopper’s phone field is visible. Y=visible (default: Y)
phonedisableY/NIndicates if the shopper’s phone field is disabled. Y=disabled (default: N)
faxvisibleY/NIndicates if the shopper’s fax field is visible. Y=visible (default: N)
faxrequireY/NIndicates if fax field is mandatory. (default: N)
faxdisableY/NIndicates if the shopper’s fax field is disabled. Y=disabled (default: N)

Encrypted parameters

BlueSnap supports a number of parameters that should be encrypted before they are added to the URL. The list below describes these parameters. For instructions on using BlueSnap's API to encrypt the parameters, see Encrypt Parameters.

ParameterTypeDescription
challenge.requestedstringIndicates if challenge should be forced on the shopper as a part of 3DS.
expirationInMinutesstringUsed to set the minutes until the page expires. Max. 1440 minutes (24hr)
Note: Returning shoppers only; otherwise, no maximum.
Example: 300
pageNamestringUsed for Auto Login
Name of the page where the shopper will be directed
Example: AUTO_LOGIN_PAGE
shopperIdstringUsed for Auto Login
ID of the shopper
Example: 19505364
sku[contract ID]priceamountstringPrice for a contract
Example: 50
sku[contract ID]pricecurrency3-letter ISO-4217 code
(case-insensitive)
Currency for a contract
Example: EUR
sku[contract ID]recurringpriceamountstringPrice for a recurring contract
Example: 100
sku[contract ID]recurringpricecurrency3-letter ISO-4217 code
(case-insensitive)
Currency for a recurring contract
Example: EUR
sku[contract ID]trialdaysstringNumber of trial days for a recurring contract
Example: 30
taxCodestringThe taxCode used to calculate the taxability of the product being purchased based on the shopper's country and zip code.
To determine the correct tax code, refer to https://taxcode.avatax.avalara.com/

Example: DG010200
thankyou.backtosellerurlstringURL where the shopper will be directed after completing the purchase. The URL must be encoded, as shown below. (encryption optional)

For example:
https:\\mywebsite.com\mypage?inv=!{invoice.id}
would be encoded as

https%3A%2F%2Fmywebsite.com%2Fmypage %3Finv%3D!%7Binvoice.id%7D