BlueSnap Checkout Secure Payment Parameters

Create Token API

Request

The following are parameters that can be included in a Create Token API request:

ParameterTypeDescription
authenticationRequired3dsboolean(Optional) Pass true to ignore your 3DS excluded countries setting.
cancelUrlstring(Optional) Required if not configured in your Payment Page Display settings .
URL where BlueSnap directs the shopper if the transaction is cancelled.
challengeRequested3dsboolean(Optional) Default is false. This should only be set to true if the merchant wishes to mandate shopper identity verification as part of the 3D Secure authentication process. See 3D Secure Guide.
currencystring(Optional) Currency code (ISO 4217) of the amount to be charged.
Required for a regular transaction. Not relevant for a subscription.
cvvstring(Optional) Pass mandatory to enforce collection of CVV for a saved card payment.
lineitemsarray of objects(Optional) Required for a regular transaction. (Not relevant for a subscription.)
Each object in the array contains the line-item details of the transaction, such as the goods/services purchased or shipping. At least one line-item object must be included in the request.
Each object contains the following properties:
  • id (string, Required)
  • amount (decimal, Required) — total price of all units in the item
  • quantity (integer, Optional) — number of units, does not affect total charge amount (Value is 1 if missing)
  • label (string, Required)
  • description (string, Optional)
  • imgUrl (string, Optional) — the relative URL of your saved image .
    For example: /developers/571747/download.jpg.
    Make sure to choose a saved image from the BlueSnap environment you're working in.
merchantTransactionIdstring(Optional) Merchant's unique ID for a new transaction. 1–50 characters. Special characters are not recommended.

Not relevant for a subscription.
modestring(Required) Use the value ‘one_time’ for a regular transaction, or the value ‘subscription’ for a subscription.
onBehalfboolean(Optional) Default is false. This should only be set to true if the transaction is completed on behalf of the shopper and not by the shopper themselves.
planItemsarray of objects(Optional) Required for a subscription. (Not relevant for a regular transaction.)
The array contains exactly one plan-item object.
The plan-item object contains the following properties:
  • id (string, Required)
  • recurringChargeAmount (decimal, Optional) — recurring charge amount for each unit
  • trialPeriodDays (integer, Optional)
  • initialChargeAmount (decimal, Optional) — initial charge amount for each unit (If missing, populated with plan data)
  • quantity (integer, Optional) — number of units, affects total charge amount (the quantity * amount is charged, for both initial and recurring charges) (Value is 1 if missing)
  • label (string, Optional)
  • description (string, Optional)
  • imgUrl (string, Optional) — the relative URL of your saved image.
    For example: /developers/571747/download.jpg.
    Make sure to choose a saved image from the BlueSnap environment you're working in.
shopperIdstring(Optional) ID of the shopper. This can be used to associate saved details with a shopper, allowing them to use those details for the current transaction. See Returning Shoppers.
successUrlstring(Optional) Required if not configured in your Payment Page Display settings . URL where BlueSnap will direct the shopper if the transaction is successful. For example, this might be a confirmation page.

Response

A successful response contains the following properties:

Property NameTypeDescription
jwtstringThe JSON Web Token, used to initialize the Hosted Payment Page.

merchantTransactionId

stringWas merchantTransactionId provided in the request?
  • Yes. The same value appears here.
  • No. A value is generated by BlueSnap to identify jwt.

sdkRequest object

sdkRequest is passed to bluesnap.redirectToPaymentPage in Step 3 of the implementation process. This object contains the following properties.

PropertyTypeDescription
displayDataobject(Optional) Contains your Hosted Payment Page settings. Supports these properties.
jwtstring(Required) Your token from Step 2.

sdkRequest.displayData property

The displayData property of your sdkRequest object supports these properties. All properties are Optional.

PropertyTypeDescription
customFieldsarray of objects
(10 max)
Each object in the array contains data to pre-populate the checkout page custom fields. If you wish to configure custom fields, refer to Configuring Page Display.
Each object contains the following properties:
  • id (string, Required) — This should correspond to either the ID or the Field Label
    that is configured for the custom field that you
    want to pre-populate.
  • value (string | boolean, Required)
hiddenFieldsarray of objects
(10 max)
Each object in the array contains a key and value pair, which will be attached to the transaction as part of the metaData array.
Each object contains the following properties:
  • key (string, Required)
  • value (string | boolean, Required)
disabledCardBrandsarray of stringsThe card brands to disable for this transaction. Default is that all the supported card brands for your configuration will be available.
Supported values:
  • AMEX
  • ARGENCARD
  • CABAL
  • CARTE_BLEUE
  • CENCOSUD
  • CHINA_UNION_PAY
  • DINERS
  • DISCOVER
  • ELO
  • HIPERCARD
  • JCB
  • MASTERCARD
  • NARANJA
  • TARJETASHOPPING
  • VISA

disableCountrySelection

booleanDefault is false. This should only be set to true if the merchant wishes to disable country selection and they have provided a valid shopper country.
disabledPaymentMethodsarray of stringsThe payment methods to disable for this transaction. Default is that all your supported payment methods will be available.
Supported values:
  • ACSS_DIRECT_DEBIT
  • APPLE_PAY
  • BECS_DIRECT_DEBIT
  • CC
  • ECP
  • GOOGLE_PAY_TOKENIZED_CARD
  • IDEAL
  • LBT
  • PAYPAL
  • SEPA
  • SOFORTUBERWEISUNG
iframeOptionsobjectSettings that only apply if the Hosted Payment Page is in an iframe.
Includes one parameter:
  • topRedirect (boolean, Optional) — If the Hosted Payment Page is open inside of an iframe and this parameter is provided and is true, redirecting to the success/cancel URLs will redirect the parent page and not just the iframe. Default: false.

Note: ApplePay and PayPal are not supported in iframe mode.
languagestringLanguage code (ISO 639-1).
Supported values:
  • en (English) (Default)
  • de (German)
  • nl (Dutch)
shopperInfoobjectDetails about the shopper to pre-populate the checkout page. Supports these properties.
softDescriptorstringDescription of the transaction, which appears on the shopper's credit card statement. Maximum 20 characters.

sdkRequest.displayData.shopperInfo object

Supports the following properties. All properties are Optional, type: string.

PropertyDescription
address1The shopper’s first address line. Only if full billing is required.
address2The shopper’s second address line. Only if full billing is required.
cityThe shopper’s city. Only if full billing is required.
countryThe two-letter code of the shopper's country.
emailThe shopper’s email address. Only if email is required.
nameThe shopper's name.

postalCode

The shopper's postal code.
stateThe two-letter code of the shopper's state. Currently supported only for the United States, Brazil, and Canada. For states in other countries, include the state within the address1 property.
Only if full billing is required.