Hosted Checkout Parameters

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.

For example, if you would like the checkout page to always appear in Danish and show the currency in Euros, regardless of where the shopper's IP address is located, you can include the language and currency parameters in the URL as follows:

https://checkout.bluesnap.com/buynow/checkout?sku2269659=1&storeid=17125&language=dANISH&currency=EUR

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
Parameter
Type
Description

backtosellervisible

Y/N

Defines whether the "Continue" button appears on the Thank You page


browsertitle


string


Defines the title of the browser page, which appears in the browser tab
Example: Checkout


browsertitlevisible


Y/N


Defines whether the title of the browser page is visible


cart.addcd


Y/N


Should the CD be added to the cart by default (default: N)


cart.open


Y/N


When set to Y, the cart on the mobile skin is expanded by default upon loading


cartvisible


Y/N


Indicates if the shopping cart is visible. Y=visible (default: Y)


cdodvisible


Y/N


Indicates if CD on demand component is visible


companylogovisible


Y/N


Defines whether the company logo is visible


couponboxvisible


Y/N


Indicates if the coupon code/gift certificate box is visible. Y=visible (default: Y, if the shopper is allowed to add an additional coupon)


couponcode


string


Coupon to be used in the purchase
Example: CYBERMONDAY


currency


3-letter ISO-4217 code
(case-insensitive)


Currency to display on the order page
Example: EUR


currencyvisible


Y/N


Indicates if the shopper currency preference field is visible. Y=visible (default: Y)


currencydisable


Y/N


Indicates if the shopper currency preference field is disabled. Y=disabled (default: N)


custom[#]


string


Sets 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]


string


Sets the value for the specified custom parameter, for the specified contract only
Example: custom.4903.sku.2131313=’Red’


edwvisible


Y/N


Indicates if the EDW component is visible


forceDesktop


Y/N


Indicates whether to force the desktop skin to display, regardless of the shopper's device


forceMobile


Y/N


Indicates whether to force the mobile skin to display, regardless of the shopper's device


language


string


Language
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


languagevisible


Y/N


Indicates if the shopper language preference field is visible. Y=visible (default: Y)


languagedisable


Y/N


Indicates if the shopper language preference field is disabled. Y=disabled (default: N)


promotionsvisible


Y/N


Indicates if promotional items are visible (default: Y, if promotional items exist)


quantitydisable


Y/N


Allows you to disable the quantity selection menu (default: N)


referrer


integer


For affiliation: the affiliate ID
Example: 123585


scid


integer


Shopping context ID
Example: 12344542


sealmcafeevisible


Y/N


Defines whether the McAfee secure seal is visible


sealverisignvisible


Y/N


Defines whether the Verisign secure seal is visible


sealvisible


Y/N


Defines whether the secure seal is visible


sellerorderid
or
seller.order.id


string


Unique ID that the merchant assigns to the transaction/order, up to 50 characters
Example: 1000


shoppingcarttotalvisible


Y/N


Indicates if the shopping cart total is visible. Y=visible (default: Y)


showupsaleprices


Y/N


Indicates if sale prices display (default: Y)


skinId


integer


ID of the skin to apply to the page
Example: 11003


sku[contractID]=#


integer


Quantity of the item (or promotional item) to be purchased
Example: sku123456=3


sku[contract ID]ald


Y/N


Y=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]name


string


Override this SKU to have the name given as the parameter value.
Example: sku1471485name=cocacola


skuimagevisible


Y/N


Defines whether the contract's image is visible


softdesc


string


Soft descriptor that should appear on the shopper’s card bill
Example: Pizza House Inc.


storecardvisible


Y/N


Defines whether the Securely store card for recurring payments option is visible
Default=Y


storeid


integer


Store ID
Example: 155


submitvisible


Y/N


Indicates whether the submit button is visible


testMode


Y/N


Indicates whether this is a test of the BuyNow flow


tid


string


For affiliation: the transaction ID
Example: 12345


upsalevisible


Y/N


Indicates 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 Console

Before the following payment option parameters can be used, the payment methods you intend to use must be enabled to “Show” in the Console. 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.

Parameter
Type
Description

payment[paymentMethod]

Y/N

Indicates 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


paymentmethodsvisible


Y/N


Indicates if the payment options widget is visible


alipay


Y/N


Indicates if Alipay is visible in the "Payment Options" section


banktransfer


Y/N


Indicates if Bank Transfer is visible in the "Payment Options" section


boletoBancario


Y/N


Indicates if Boleto Bancario is visible in the "Payment Options" section


ecp


Y/N


Indicates if ECP is visible in the "Payment Options" section


cc


Y/N


Indicates if Credit Cards is visible in the "Payment Options" section


paypal


Y/N


Indicates if PayPal is visible in the "Payment Options" section


skrill


Y/N


Indicates if Skrill (aka. Moneybookers) is visible in the "Payment Options" section


moneybookers


Y/N


Indicates if Moneybookers (aka. Skrill) is visible in the "Payment Options" section


webmoney


Y/N


Indicates if WebMoney is visible in the "Payment Options" section


wire


Y/N


Indicates if Wire is visible in the "Payment Options" section


paysafecard


Y/N


Indicates if paysafe is visible in the "Payment Options" section


realtimebank


Y/N


Indicates if real time bank transfer is visible in the "Payment Options" section


ccnumbervisible


Y/N


Indicates if the CC number field is visible (default: Y)


cctypevisible


Y/N


Indicates if the CC type field is visible (default: Y)


cctypedisable


Y/N


Indicates if the CC type field is disabled. Y=disabled (default: N)


ccdatevisible


Y/N


Indicates if the CC expiration date field is visible (default: Y)


ccdatedisable


Y/N


Indicates if the CC expiration date field is disabled. Y=disabled (default: N)


expirationmonth


integer


CC expiration month
Example: 12


expirationyear


integer


CC expiration year
Example: 2019


ccstartdatevisible


Y/N


Indicates if the CC start date field is visible (default: Y, if start date is applicable for the selected CC type)


ccstartdatedisable


Y/N


Indicates if the CC start date field is disabled. Y=disabled (default: N)


ccstartmonth


integer


CC start month
Example: 09


ccstartyear


integer


CC start year
Example: 2015


cccodevisible


Y/N


Indicates if the CC security code field is visible (default: Y, if start date is applicable for the selected CC type)


cccodedisable


Y/N


Indicates 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.

Parameter
Type
Description

selectedPaymentMethod

String

Specifies 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.

Parameter
Type
Description

billingfirstname

string

First name
Example: John


billinglastname


string


Last name
Example: Doe


billingfullName


string


Full billing name
Example: JohnDoe


billingaddress1


string


Address line 1
Example: 1234 St. James Dr.


billingaddress2


string


Address line 2
Example: Suite 123


billingcity


string


City
Example: San Diego


billingstate


string


State
Example: CA


billingzipcode


string


ZIP code or postal code
Example: 78467


billinginfocheckboxvisible


Y/N


Indicates if the billing info check box is visible. Y=visible (default: N)


billinginfovisible


Y/N


Indicates 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)


billinginfodisable


Y/N


Indicates if the billing info widget is disabled. Y=disabled (default: N)


billingfullnamevisible


Y/N


Indicates if the billing full name field is visible. Y=visible (default: Y)


billingfullnamedisable


Y/N


Indicates if the billing full name field is disabled. Y=disabled (default: N)


billingfirstnamevisible


Y/N


Indicates if the billing first name field is visible. Y=visible (default: Y)


billingfirstnamedisable


Y/N


Indicates if the billing first name field is disabled. Y=disabled (default: N)


billinglastnamevisible


Y/N


Indicates if the billing last name field is visible. Y=visible (default: Y)


billinglastnamedisable


Y/N


Indicates if the billing last name field is disabled. Y=disabled (default: N)


billingaddress1visible


Y/N


Indicates if the billing address 1 field is visible. Y=visible (default: Y)


billingaddress1disable


Y/N


Indicates if the billing address 1 field is disabled. Y=disabled (default: N)


billingaddress2visible


Y/N


Indicates if the billing address 2 field is visible. Y=visible (default: N)


billingaddress2disable


Y/N


Indicates if the billing address 2 field is disabled. Y=disabled (default: N)


billingcityvisible


Y/N


Indicates if the billing city field is visible. Y=visible (default: Y)


billingcitydisable


Y/N


Indicates if the billing city field is disabled. Y=disabled (default: N)


billingzipvisible


Y/N


Indicates if the billing zip code field is visible. Y=visible (default: Y)


billingzipdisable


Y/N


Indicates if the billing zip code field is disabled. Y=disabled (default: N)


billingcountryvisible


Y/N


Indicates if the billing country field is visible. Y=visible (default: Y)


billingcountrydisable


Y/N


Indicates if the billing country field is disabled. Y=disabled (default: N)


billingstatevisible


Y/N


Indicates if the billing state field is visible. Y=visible (default: Y, but only if relevant by the selected country)


billingstatedisable


Y/N


Indicates 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 when either:
(1) the 'Collect Shipping Address' option is enabled in the contract's settings (under General Settings > Miscellaneous); or
(2) the shopper opts to include a 'CD on Demand' in their order.

Parameter
Type
Description

shippingfirstname

string

First name
Example: John


shippinglastname


string


Last name
Example: Doe


shippingfullName


string


Full name
Example: JohnDoe


shippingaddress1


string


Address line 1
Example: 1234 St. James Dr.


shippingaddress2


string


Address line 2
Example: Suite 123


shippingcity


string


City
Example: San Diego


shippingstate


string


State
Example: CA


shippingzipcode


string


ZIP code or postal code
Example: 78467


shippingcountry


2-letter ISO_3166-1 code


Country
Example: US


shippinginfocheckboxvisible


Y/N


Indicates if the shipping info checkbox is visible. Y=visible (default: N)


shippinginfovisible


Y/N


Indicates 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)


shippinginfodisable


Y/N


Indicates if the shipping info widget is disabled. Y=disabled (default: N)


shippingfirstnamevisible


Y/N


Indicates if the shipping first name field is visible. Y=visible (default: Y)


shippingfirstnamedisable


Y/N


Indicates if the shipping first name field is disabled. Y=disabled (default: N)


shippinglastnamevisible


Y/N


Indicates if the shipping last name field is visible. Y=visible (default: Y)


shippinglastnamedisable


Y/N


Indicates if the shipping last name field is disabled. Y=disabled (default: N)


shippingfullnamevisible


Y/N


Indicates if the shipping full name field is visible. Y=visible (default: Y)


shippingfullnamedisable


Y/N


Indicates if the shipping full name field is disabled. Y=disabled (default: N)


shippingaddress1visible


Y/N


Indicates if the shipping address 1 field is visible. Y=visible (default: Y)


shippingaddress1disable


Y/N


Indicates if the shipping address 1 field is disabled. Y=disabled (default: N)


shippingaddress2visible


Y/N


Indicates if the shipping address 2 field is visible. Y=visible (default: N)


shippingaddress2disable


Y/N


Indicates if the shipping address 2 field is disabled. Y=disabled (default: N)


shippingcityvisible


Y/N


Indicates if the shipping city field is visible. Y=visible (default: Y)


shippingcitydisable


Y/N


Indicates if the shipping city field is disabled. Y=disabled (default: N)


shippingzipvisible


Y/N


Indicates if the shipping zip code field is visible. Y=visible (default: Y)


shippingzipdisable


Y/N


Indicates if the shipping zip code field is disabled. Y=disabled (default: N)


shippingcountryvisible


Y/N


Indicates if the shipping country field is visible. Y=visible (default: Y)


shippingcountrydisable


Y/N


Indicates if the shipping country field is disabled. Y=disabled (default: N)


shippingstatevisible


Y/N


Indicates if the shipping state field is visible. Y=visible (default: Y, but only if relevant for the selected country)


shippingstatedisable


Y/N


Indicates 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.

Parameter
Type
Description

invoiceinfocheckboxvisible

Y/N

Indicates if the invoice checkbox is visible. Y=visible


invoiceinfovisible


Y/N


Indicates if the invoice info is visible. Y=visible


invoiceinfodisable


Y/N


Indicates if the invoice info is disabled. Y=disabled


invoiceaddress1


string


Address line 1 on the invoice
Example: 1234 St. James Dr.


invoiceaddress1visible


Y/N


Indicates if the address 1 field is visible. Y=visible


invoiceaddress1disable


Y/N


Indicates if the address 1 field is disabled. Y=disabled


invoiceaddress2


string


Address line 2 on the invoice
Example: Suite 100


invoiceaddress2visible


Y/N


Indicates if the address 2 field is visible. Y=visible


invoiceaddress2disable


Y/N


Indicates if the address 2 field is disabled. Y=disabled


invoicecity


string


City on the invoice
Example: San Diego


invoicecityvisible


Y/N


Indicates if the city field is visible. Y=visible


invoicecitydisable


Y/N


Indicates if the city field is disabled. Y=disabled


invoicecompanyname


string


Company name on the invoice
Example: Acme


invoicecompanynamevisible


Y/N


Indicates if the company name field is visible. Y=visible


invoicecompanynamedisable


Y/N


Indicates if the company name field is disabled. Y=disabled


invoicecountry


2-letter ISO_3166-1 code


Country on the invoice
Example: US


invoicecountryvisible


Y/N


Indicates if the country field is visible. Y=visible


invoicecountrydisable


Y/N


Indicates if the country field is disabled. Y=disabled


invoiceemail


string


Email on the invoice
Example: john@example.com


invoiceemailvisible


Y/N


Indicates if the email field is visible. Y=visible


invoiceemaildisable


Y/N


Indicates if the email field is disabled. Y=disabled


invoicefirstName


string


First name on the invoice
Example: John


invoicefirstnamevisible


Y/N


Indicates if the first name field is visible. Y=visible


invoicefirstnamedisable


Y/N


Indicates if the first name field is disabled. Y=disabled


invoicefullName


string


Full name on the invoice
Example: John Doe


invoicefullnamevisible


Y/N


Indicates if the full name field is visible. Y=visible


invoicefullnamedisable


Y/N


Indicates if the full name field is disabled. Y=disabled


invoicelastName


string


Last name on the invoice
Example: Doe


invoicelastnamevisible


Y/N


Indicates if the last name field is visible. Y=visible


invoicelastnamedisable


Y/N


Indicates if the last name field is disabled. Y=disabled


invoicestate


string


State on the invoice
Example: CA


invoicestatevisible


Y/N


Indicates if the state field is visible. Y=visible


invoicestatedisable


Y/N


Indicates if the state field is disabled. Y=disabled


invoicetitle


string


Title on the invoice
Example: Mr


invoicetitlevisible


Y/N


Indicates if the title field is visible. Y=visible


invoicetitledisable


Y/N


Indicates if the title field is disabled. Y=disabled


invoiceworkphone


string


Work phone number on the invoice
Example: 800-123-4567


invoicephonevisible


Y/N


Indicates if the phone number field is visible. Y=visible


invoicephonedisable


Y/N


Indicates if the phone number field is disabled. Y=disabled


invoicezipcode


string


ZIP code on the invoice
Example: 01234


invoicezipvisible


Y/N


Indicates if the ZIP code field is visible. Y=visible


invoicezipdisable


Y/N


Indicates 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.

Parameter
Type
Description

title

string

Title
Example: Mr


companyname


string


Company name
Example: Best Company


firstname


string


First name
Example: John


lastname


string


Last name
Example: Doe


fullname


string


Full name
Example: John Doe


email


string


Email
Example: shopper@shopper.com


address1


string


Address line 1
Example: 1234 St. James Dr.


address2


string


Address line 2
Example: Suite 123


city


string


City
Example: San Diego


state


string


State
Example: CA


country


2-letter ISO_3166-1 code


Country
Example: US


zip


string


ZIP code or postal code
Example: 78467


workphone


string


Work phone number
Example: 3456789123


faxnumber


string


Fax number
Example: 9876543333


shoppersprefvisible


Y/N


Indicates if the shopper language and currency preference fields are visible. Y=visible (default: Y)


shoppersprefdisable


Y/N


Indicates if the shopper language and currency preference fields are disabled. Y=disabled (default: N)


shopperinfovisible


Y/N


Indicates if the shopper information fields are visible. Y=visible (default: Y)


shopperinfodisable


Y/N


Indicates if the shopper information fields are disabled. Y=disabled (default:N)


accountdetailsinfovisible


Y/N


Indicates if the shopper account details are visible. Y=visible


companynamevisible


Y/N


Indicates if the company name field is visible. Y=visible (default: N)


companynamerequire


Y/N


Indicates if the company name field is mandatory. (default: N)


companynamedisable


Y/N


Indicates if the company name field is disabled. Y=disabled (default: N)


titlevisible


Y/N


Indicates if shopper's title field is visible. Y=visible (default: N)


titlerequire


Y/N


Indicates if shopper title is mandatory. (default: N)


titledisable


Y/N


Indicates if shopper title field is disabled. Y=disabled (default: N)


firstnamevisible


Y/N


Indicates if shopper first name field is visible. Y=visible (default: Y)


firstnamedisable


Y/N


Indicates if the shopper first name field is disabled. Y=disabled (default: N)


lastnamevisible


Y/N


Indicates if shopper last name field is visible. Y=visible (default: Y)


lastnamedisable


Y/N


Indicates if the shopper last name field is disabled. Y=disabled (default: N)


fullnamevisible


Y/N


Indicates if shopper full name field is visible. Y=visible (default: Y)


fullnamedisable


Y/N


Indicates if the shopper full name field is disabled. Y=disabled (default: N)


emailvisible


Y/N


Indicates if the shopper email field is visible. Y=visible (default: Y)


address1visible


Y/N


Indicates if the address line 1 field is visible. Y=visible (default: Y)


address1disable


Y/N


Indicates if the address line 1 field is disabled. Y=disabled (default: N)


address2visible


Y/N


Indicates if the address line 2 field is visible. Y=visible (default: N)


address2require


Y/N


Indicates if the address line 2 field is mandatory. (default: N)


address2disable


Y/N


Indicates if the address line 2 field is disabled. Y=disabled (default: N)


cityvisible


Y/N


Indicates if the city field is visible. Y=visible (default: Y)


citydisable


Y/N


Indicates if the city field is disabled. Y=disabled


zipvisible


Y/N


Indicates if the ZIP code field is visible. Y=visible (default: Y)


zipdisable


Y/N


Indicates if the ZIP code field is disabled. Y=disabled (default: N)


countryvisible


Y/N


Indicates if the shopper’s country field is visible. Y=visible (default: Y)


countrydisable


Y/N


Indicates if the shopper’s country field is disabled. Y=disable (default:N)


statevisible


Y/N


Indicates if the shopper’s state field is visible. Y=visible (default: Y, but only if relevant for the selected country)


statedisable


Y/N


Indicates if the shopper’s state field is disabled. Y=disabled (default: N)


phonevisible


Y/N


Indicates if the shopper’s phone field is visible. Y=visible (default: Y)


phonedisable


Y/N


Indicates if the shopper’s phone field is disabled. Y=disabled (default: N)


faxvisible


Y/N


Indicates if the shopper’s fax field is visible. Y=visible (default: N)


faxrequire


Y/N


Indicates if fax field is mandatory. (default: N)


faxdisable


Y/N


Indicates 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.

Parameter
Type
Description

expirationInMinutes

string

Used to set the minutes until the page expires. Max. 1440 minutes (24hr)
Note: Returning shoppers only; otherwise, no maximum.
Example: 300


pageName


string


Used for Auto Login
Name of the page where the shopper will be directed
Example: AUTO_LOGIN_PAGE


shopperId


string


Used for Auto Login
ID of the shopper
Example: 19505364


sku[contract ID]priceamount


string


Price for a contract
Example: 50


sku[contract ID]pricecurrency


3-letter ISO-4217 code
(case-insensitive)


Currency for a contract
Example: EUR


sku[contract ID]recurringpriceamount


string


Price for a recurring contract
Example: 100


sku[contract ID]recurringpricecurrency


3-letter ISO-4217 code
(case-insensitive)


Currency for a recurring contract
Example: EUR


sku[contract ID]trialdays


string


Number of trial days for a recurring contract
Example: 30


taxCode


string


The 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.backtosellerurl


string


URL 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

Hosted Checkout Parameters


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.