Shopper Portal Parameters

BlueSnap supports a number of parameters for the Shopper Portal, allowing you to direct the shopper to a specific page in their account, change payment details for a specific subscription, etc. See Returning Shoppers for more information on how to use Shopper Portal parameters.

Name

Type

Description

Required

target

String

Specifies the target page to display.
cp - Shopper's specific Portal

Yes

token

String

Specifies a unique string that BlueSnap returns and which the Merchant uses to request customer access to BlueSnap target pages. These target pages contain previously registered customer and payment details.

Yes

pageToShow

String

Specifies the target page to display to the customer when a request is triggered from the Merchant's site.

Supported target pages for pageToShow:

  • my_account.jsp -
    Displays customer's main account page
  • account_change_password.jsp -
    Sends the customer to the Change Login Information page
  • account_cc.jsp -
    Sends the customer to the Manage Cards page. From this page customers can delete any listed credit cards.
  • acc_rep_charges.jsp - Sends the customer to the Charges Report page where they can view previous charges.

    Specific Target Pages for Subscription Management:
  • choose_contract.jsp - Sends the customer to the Choose Plan page where they can select an alternative plan. In order to display this page, you must also pass the subscriptionId and productId parameters.
  • account_contract_ici.jsp - Sends the customer to the Invoice Information page where they can update invoice details. In order to display this page, you must also pass the subscriptionId parameter.
  • change_cc.jsp - Sends the customer to the Credit Card Information page where the customer can select a different card for payment of the selected subscription. In order to display this page, you must also pass the subscriptionId parameter.

Yes

subscriptionId

String

Specifies the active subscription.

No

productId

String

Specifies the product associated with the active subscription. This will allow the customer to choose a new plan to switch to.

No