Optional Parameters

Highly Recommended

Table 1. Highly Recommended Optional Parameters
Parameter	Within fingerprint	Data type	Description
`confirmUrl`	Required	Alphanumeric with special characters	URL of the online shop where hobex Service IT sends a server-to-server confirmation
`customerStatement`	Required	Alphanumeric with special characters, up to 254 characters	Text displayed on bank statement issued to the consumer by the financial service provider.
`orderReference`	Required	Alphanumeric with special characters, up to 128 characters	Unique order reference ID sent from merchant to financial institution. Correlate the order numbers of the online shop with the affected payments.
`pendingUrl`	Optional	Alphanumeric with special characters	URL of the online shop when the result of the payment process could not be determined yet.

Table 2. Highly Recommended Optional Parameters
confirmUrl
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters
Description	URL of the online shop where hobex Service IT sends a server-to-server confirmation
customerStatement
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters, up to 254 characters
Description	Text displayed on bank statement issued to the consumer by the financial service provider.
orderReference
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters, up to 128 characters
Description	Unique order reference ID sent from merchant to financial institution. Correlate the order numbers of the online shop with the affected payments.
pendingUrl
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters
Description	URL of the online shop when the result of the payment process could not be determined yet.

The consumer billing data, consumer shipping data, and shopping basket data should be implemented from the beginning since these are required for certain payment methods.

Table 3. Optional Parameters
Parameter	Within fingerprint	Data type	Description
`noScriptInfoUrl`	Optional	Alphanumeric with special characters	URL of the online shop where the information page regarding deactivated JavaScript resides
`orderNumber`	Required	Numeric, up to 9	Order number of payment
`windowName`	Optional	Alphanumeric	Window name of browser window where payment page is opened.
`duplicateRequestCheck`	Required	Boolean	Check for duplicate requests done by the consumer.
`transactionIdentifier`	Required	Enumeration	Possible values are `SINGLE` for one-off transactions or `INITIAL` for the first transaction of a series of recurring transactions.
`cssUrl`	Optional	URL	URL to a CSS file on the server to perform customizations
`isoTransactionType`	Required	Enumeration	It identifies the type of ISO transaction and the values are derived from ISO 8583. This field is required in some markets (e.g. for Merchants in Brazil), otherwise optional. Accepted values: `01` = Goods/ Service Purchase. `03` = Check Acceptance. `10` = Account Funding. `11` = Quasi-Cash Transaction. `28` = Prepaid Activation and Load.

Table 4. Optional Parameters
`noScriptInfoUrl`
Data	Value
Within fingerprint	Optional
Data type	Alphanumeric with special characters
Description	URL of the online shop where the information page regarding deactivated JavaScript resides
`orderNumber`
Data	Value
Within fingerprint	Required if used
Data type	Numeric, up to 9
Description	Order number of payment
`windowName`
Data	Value
Within fingerprint	Optional
Data type	Alphanumeric
Description	Window name of browser window where payment page is opened.
`duplicateRequestCheck`
Data	Value
Within fingerprint	Required if used
Data type	Boolean
Description	Check for duplicate requests done by the consumer.
`transactionIdentifier`
Data	Value
Within fingerprint	Required if used
Data type	Enumeration
Description	Possible values are `SINGLE` for one-off transactions or `INITIAL` for the first transaction of a series of recurring transactions.
`cssUrl`
Data	Value
Within fingerprint	Optional
Data type	URL
Description	URL to a CSS file on the server to perform customizations
`isoTransactionType`
Data	Value
Within fingerprint	Required if used
Data type	Enumeration
Description	It identifies the type of ISO transaction and the values are derived from ISO 8583. This field is required in some markets (e.g. for Merchants in Brazil), otherwise optional. Accepted values: `01` = Goods/ Service Purchase. `03` = Check Acceptance. `10` = Account Funding. `11` = Quasi-Cash Transaction. `28` = Prepaid Activation and Load.

Table 5. Additionally for Checkout Page
Parameter	Within fingerprint	Data type	Description
`displayText`	Optional	Alphanumeric with special characters	Text displayed to the consumer during the payment process.
`imageUrl`	Optional	Alphanumeric with special characters	URL of the online shop where the online shop logo is located.
`backgroundColor`	Optional	Alphanumeric	Hex code RGB color value as background color for the brand image containing the credit card logos.
`financialInstitution`	Optional	Enumeration	Sub-selection of financial institutions regarding the pre-selected payment method.

Table 6. Additionally for Checkout Page
`displayText`
Data	Value
Within fingerprint	Optional
Data type	Alphanumeric with special characters
Description	Text displayed to the consumer during the payment process.
`imageUrl`
Data	Value
Within fingerprint	Optional
Data type	Alphanumeric with special characters
Description	URL of the online shop where the online shop logo is located.
`backgroundColor`
Data	Value
Within fingerprint	Optional
Data type	Alphanumeric
Description	Hex code RGB color value as background color for the brand image containing the credit card logos.
`financialInstitution`
Data	Value
Within fingerprint	Optional
Data type	Enumeration
Description	Sub-selection of financial institutions regarding the pre-selected payment method.

Table 7. Additionally for Checkout Seamless
Parameter	Within fingerprint	Data type	Description
`orderIdent`	Required	Alphanumeric with special characters	Unique ID of order which has to be the same as used for initiating the Data Storage.
`storageId`	Required	Alphanumeric with a fixed length of 32	Unique ID of Data Storage for a specific consumer.

Parameters orderIdent and storageID become mandatory if data storage is used.

Consumer Data

These parameters are used to pass on detailed information to the consumer and some specific payment methods are required.

Optional Parameters For Consumers

Table 8. Optional Parameters For Consumers
Parameter	Within fingerprint	Data type	Description
`consumerEmail`	Required	Alphanumeric with special characters, up to 256 characters	E-mail address of the consumer.
`consumerBirthDate`	Required	Numeric with special characters, fixed-length 10	Birth date of the consumer in the format `YYYY-MM-DD`.
`consumerTaxiIdentificationNumber`	Required	Alphanumeric with special characters, up to 32 characters	Tax identification number of consumer.
`consumerDriversLicenseNumber`	Required	Alphanumeric with special characters, up to 32 characters	Drivers license number of consumer.
`consumerDriversLicenseState`	Required	Alphabetic with a fixed length of 2 for the US and CA; otherwise, up to 40	State which issued the driver’s license of the consumer.
`consumerDriversLicenseCountry`	Required	Alphabetic, fixed length of 2 characters	Country which issued the drivers license of consumer.
`consumerMerchantCrmId`	Required	Alphanumeric, up to 50 characters	Unique ID identifying the consumer of the online shop. The parameter must not be a human-readable e-mail address.
`consumerAuthenticationMethod`	Required	Enumeration	Type of consumer login in the shop. Accepted values: `01` = Guest checkout `02` = Login to the consumer’s account in the shop with shop-own authentication credentials. `03` = Login with Federated ID. `04` = Login with card issuer credentials. `05` = Login with third-party authentication. `06` = Login with FIDO authenticator.
`consumerAuthenticationTimestamp`	Required	Timestamp	Date and time of the consumer login to the shop. Accepted format: `YYYY-MM-DDThh:mm:ssZ`. For guest checkout, the timestamp is now.
`consumerCardProvisionDate`	Required	Numeric with special characters, fixed length of 10	Date that the consumer’s card was added to their account in the shop for card-on-file payments. Accepted format: `DD.MM.YYYY`. For all other types of checkout, the date is now.
`consumerCardProvisionAttemptsPastDay`	Required	Numeric, up to 9 characters	Number of cards the consumer has attempted to add to their account in the shop for card-on-file payments in the past 24 hours.
`consumerChallengeIndicator`	Required	Enumeration	Specifies whether transaction shall be subject to Strong Customer Authentication (SCA). Accepted values: `01` = No preference. `02` = No challenge requested. `03` = Challenge requested. (3DS Requestor preference). `04` = Challenge requested (Mandate). If the element is not provided, the ACS will interpret it as `01` = No preference.
`consumerSuspiciousActivity`	Required	Boolean	Indicates if merchants have experienced suspicious activities by the consumer.
`consumerDeliveryTimeframe`	Required	Enumeration	Delivery time frame. Accepted values: `01` = Electronic Delivery. `02` = Same day shipping. `03` = Overnight shipping. `04` = Two-day or more shipping.
`consumerPreorderDate`	Required	Numeric with special characters, fixed length of 10	The expected date that the item will be available for a pre-ordered purchase. Accepted format: `DD.MM.YYYY`.
`consumerReorderItems`	Required	Enumeration	Indicates if the consumer is reordering previously purchased items. Accepted values: `01` = First time ordered. `02` = Reordered.
`consumerAccountCreationDate`	Required	Numeric with special characters, fixed length of 10	Registration date of the consumer’s account in the shop. Accepted format: `DD.MM.YYYY`. For guest checkout, don’t send this field.
`consumerAccountUpdateDate`	Required	Numeric with special characters, fixed length of 10	Date that the consumer last made changes to their account in the shop. Accepted format: `DD.MM.YYYY`. For guest checkout, don’t send this field.
`consumerAccountPasswordChangeDate`	Required	Numeric with special characters, fixed length of 10	Date that the consumer last changed/reset their password in the shop. Accepted format: `DD.MM.YYYY`. For guest checkout, don’t send this field.
`consumerAccountPurchasesPastSixMonths`	Required	Numeric, up to 9 characters	Number of successful orders by the consumer in the shop within the past six months.
`consumerAccountTransactionsPastDay`	Required	Numeric, up to 9 characters	Number of transactions that the consumer has attempted in the past 24 hours. Does not include merchant-initiated transactions.
`consumerAccountTransactionsPastYear`	Required	Numeric, up to 9 characters	Number of transactions that the consumer has attempted in the past year. Does not include merchant-initiated transactions.

Table 9. Optional Parameters For Consumers
`consumerEmail`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters, up to 256 characters
Description	E-mail address of the consumer.
`consumerBirthDate`
Data	Value
Within fingerprint	Required if used
Data type	Numeric with special characters, fixed-length 10
Description	Birth date of the consumer in the format `YYYY-MM-DD`.
`consumerTaxiIdentificationNumber`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters, up to 32 characters
Description	Tax identification number of consumer.
`consumerDriversLicenseNumber`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters, up to 32 characters
Description	Drivers license number of consumer.
`consumerDriversLicenseState`
Data	Value
Within fingerprint	Required if used
Data type	Alphabetic with a fixed length of 2 for the US and CA; otherwise, up to 40
Description	State which issued the driver’s license of the consumer.
`consumerDriversLicenseCountry`
Data	Value
Within fingerprint	Required if used
Data type	Alphabetic, fixed length of 2 characters
Description	Country which issued the drivers license of consumer.
`consumerMerchantCrmId`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 50 characters
Description	Unique ID identifying the consumer of the online shop. The parameter must not be a human-readable e-mail address.
`consumerAuthenticationMethod`
Data	Value
Within fingerprint	Required if used
Data type	Enumeration
Description	Specifies whether transaction shall be subject to Strong Customer Authentication (SCA). Accepted values: `01` = No preference. `02` = No challenge requested. `03` = Challenge requested. (3DS Requestor preference). `04` = Challenge requested (Mandate). If the element is not provided, the ACS will interpret it as `01` = No preference.
`consumerSuspiciousActivity`
Data	Value
Within fingerprint	Required if used
Data type	Boolean
Description	Indicates if merchants have experienced suspicious activities by the consumer.
`consumerDeliveryTimeframe`
Data	Value
Within fingerprint	Required if used
Data type	Enumeration
Description	Delivery time frame. Accepted values: `01` = Electronic Delivery. `02` = Same day shipping. `03` = Overnight shipping. `04` = Two-day or more shipping.
`consumerPreorderDate`
Data	Value
Within fingerprint	Required if used
Data type	Numeric with special characters, fixed length of 10
Description	The expected date that the item will be available for a pre-ordered purchase. Accepted format: `DD.MM.YYYY`.
`consumerReorderItems`
Data	Value
Within fingerprint	Required if used
Data type	Enumeration
Description	Indicates if the consumer is reordering previously purchased items. Accepted values: `01` = First time ordered. `02` = Reordered.
`consumerAccountCreationDate`
Data	Value
Within fingerprint	Required if used
Data type	Numeric with special characters, fixed length of 10
Description	Registration date of the consumer’s account in the shop. Accepted format: `DD.MM.YYYY`. For guest checkout, don’t send this field.
`consumerAccountUpdateDate`
Data	Value
Within fingerprint	Required if used
Data type	Numeric with special characters, fixed length of 10
Description	Date that the consumer last made changes to their account in the shop. Accepted format: `DD.MM.YYYY`. For guest checkout, don’t send this field.
`consumerAccountPasswordChangeDate`
Data	Value
Within fingerprint	Required if used
Data type	Numeric with special characters, fixed length of 10
Description	Date that the consumer last changed/reset their password in the shop. Accepted format: `DD.MM.YYYY`. For guest checkout, don’t send this field.
`consumerAccountPurchasesPastSixMonths`
Data	Value
Within fingerprint	Required if used
Data type	Numeric, up to 9 characters
Description	Number of successful orders by the consumer in the shop within the past six months.
`consumerAccountTransactionsPastDay`
Data	Value
Within fingerprint	Required if used
Data type	Numeric, up to 9 characters
Description	Number of transactions that the consumer has attempted in the past 24 hours. Does not include merchant-initiated transactions.
`consumerAccountTransactionsPastYear`
Data	Value
Within fingerprint	Required if used
Data type	Numeric, up to 9 characters
Description	Number of transactions that the consumer has attempted in the past year. Does not include merchant-initiated transactions.

Consumer Billing Data

Table 10. Consumer Billing Data
Parameter	Within fingerprint	Data type	Description
`consumerBillingFirstname`	Required	First character has to be alphabetic, any other characters ASCII, up to 30 bytes	First name of consumer.
`consumerBillingLastname`	Required	First character has to be alphabetic, any other characters ASCII, up to 30 bytes	Last name of consumer.
`consumerBillingAddress1`	Required	Alphanumeric, up to 100 bytes	Name of the street and optionally the house number.
`consumerBillingAddress2`	Required	Alphanumeric, up to 100 bytes	The house number if not already set in `consumerBillingAddress1`.
`consumerBillingAddress3`	Required	Alphanumeric, up to 100 bytes	Further details regarding consumer’s address.
`consumerBillingCity`	Required	Alphanumeric, up to 32 bytes	Billing city
`consumerBillingState`	Required	If the `consumerBillingCountry` is US or CA-Alphabetic, fixed 2 characters and can’t be empty. For all other country codes-Alphabetic, the max length is 3 characters.	Billing state code ISO 3166-2.
`consumerBillingCountry`	Required	Alphabetic, fixed 2 characters	Billing country code ISO 3166-1.
`consumerBillingZipCode`	Required	Alphanumeric, up to 12 characters	Billing zip code.
`consumerBillingPhone`	Required	Alphanumeric, up to 20 characters	Phone number of consumer.
`consumerBillingMobilePhone`	Required	Alphanumeric, up to 18 characters	Mobile phone number of consumer.
`consumerBillingFax`	Required	Alphanumeric, up to 20 characters	Fax number of consumer.

Table 11. Consumer Billing Data
`consumerBillingFirstname`
Data	Value
Within fingerprint	Required if used
Data type	First character has to be alphabetic, any other characters ASCII, up to 30 bytes
Description	First name of consumer.
`consumerBillingLastname`
Data	Value
Within fingerprint	Required if used
Data type	First character has to be alphabetic, any other characters ASCII, up to 30 bytes
Description	Last name of consumer.
`consumerBillingAddress1`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 100 bytes
Description	Name of the street and optionally the house number.
`consumerBillingAddress2`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 100 bytes
Description	The house number if not already set in `consumerBillingAddress1`.
`consumerBillingAddress3`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 100 bytes
Description	Further details regarding consumer’s address.
`consumerBillingCity`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 32 bytes
Description	Billing city
`consumerBillingState`
Data	Value
Within fingerprint	Required if used
Data type	If the `consumerBillingCountry` is US or CA-Alphabetic, fixed 2 characters and can’t be empty. For all other country codes-Alphabetic, the max length is 40 characters and there is no minimum length.
Description	Billing state
`consumerBillingCountry`
Data	Value
Within fingerprint	Required if used
Data type	Alphabetic, fixed 2 characters
Description	Billing country code ISO 3166-1.
`consumerBillingZipCode`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 12 characters
Description	Billing zip code.
`consumerBillingPhone`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 20 characters
Description	Phone number of consumer
`consumerBillingMobilePhone`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 18 characters
Description	Mobile phone number of consumer.
`consumerBillingFax`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 18 characters
Description	Fax number of consumer.

Consumer Shipping Data

Table 12. Consumer Shipping Data
Parameter	Within fingerprint	Data type	Description
`consumerShippingFirstName`	Required	First character has to be alphabetic, any other characters ASCII, up to 30 bytes	First name of the consumer.
`consumerShippingLastName`	Required	First character has to be alphabetic, any other characters ASCII, up to 30 bytes	Last name of the consumer.
`consumerShippingAddress1`	Required	Alphanumeric, up to 100 bytes	Name of the street and optionally the house number.
`consumerShippingAddress2`	Required	Alphanumeric, up to 100 bytes	The house number if not already set in `consumerShippingAddress1`.
`consumerShippingCity`	Required	Alphanumeric, up to 32 bytes	Shipping city.
`consumerShippingState`	Required	If the `consumerShippingCountry` is US or CA-Alphabetic, fixed 2 characters and can’t be empty. For all other country codes-Alphabetic, the max length is 40 characters and there is no minimum length.	Shipping state.
`consumerShippingCountry`	Required	Alphabetic, fixed 2 characters	Shipping country code ISO 3166-1.
`consumerShippingZipCode`	Required	Alphanumeric, up to 12	Shipping ZIP code.
`consumerShippingPhone`	Required	Alphanumeric, up to 20	Shipping phone number.
`consumerShippingFax`	Required	Alphanumeric, up to 20	Shipping fax number.
`consumerShippingItemAvailability`	Required	Enumeration	Indicates whether consumer is placing an order for an item that is not yet available or which is currently available. Accepted values: `01` = Currently available `02` = Future availability.
`consumerShippingMethod`	Required	Enumeration	Shipping method chosen by the consumer. Accepted values: `home_delivery`: Ship to consumer’s billing address `verified_address_delivery`: Ship to verified address `other_address_delivery`: Ship to an address that differs from the consumer’s billing address `store_pick_up`: Ship to Store/Pick-up at local store `digital_goods`: e.g. gift cards, `digital_tickets`: Travel and event tickets, not shipped `other_verified`: Other e-media subscriptions.
`consumerShippingAddressFirstUseDate`	Required	Numeric with special characters, fixed 10	Date that the consumer first used this shipping address in the shop. Accepted format: `DD.MM.YYYY`.

Table 13. Consumer Shipping Data
`consumerShippingFirstName`
Data	Value
Within fingerprint	Required if used
Data type	First character has to be alphabetic, any other characters ASCII, up to 30 bytes
Description	First name of the consumer.
`consumerShippingLastName`
Data	Value
Within fingerprint	Required if used
Data type	First character has to be alphabetic, any other characters ASCII, up to 30 bytes
Description	Last name of the consumer.
`consumerShippingAddress1`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 100 bytes
Description	Name of the street and optionally the house number.
`consumerShippingAddress2`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 100 bytes
Description	The house number if not already set in `consumerShippingAddress1`.
`consumerShippingCity`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 32 bytes
Description	Shipping city.
`consumerShippingState`
Data	Value
Within fingerprint	Required if used
Data type	If the `consumerShippingCountry` is US or CA-Alphabetic, fixed 2 characters and can’t be empty. For all other country codes-Alphabetic, the max length is 40 characters and there is no minimum length.
Description	Shipping state.
`consumerShippingCountry`
Data	Value
Within fingerprint	Required if used
Data type	Alphabetic, fixed 2 characters
Description	Shipping country code ISO 3166-1.
`consumerShippingZipCode`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 12
Description	Shipping ZIP code.
`consumerShippingPhone`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 20
Description	Shipping phone number.
`consumerShippingFax`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 20
Description	Shipping fax number.
`consumerShippingItemAvailability`
Data	Value
Within fingerprint	Required if used
Data type	Enumeration
Description	Indicates whether consumer is placing an order for an item that is not yet available or which is currently available. Accepted values: `01` = Currently available `02` = Future availability.
`consumerShippingMethod`
Data	Value
Within fingerprint	Required if used
Data type	Enumeration
Description	Shipping method chosen by the consumer. Accepted values: `home_delivery`: Ship to consumer’s billing address `verified_address_delivery`: Ship to verified address `other_address_delivery`: Ship to an address that differs from the consumer’s billing address `store_pick_up`: Ship to Store/Pick-up at local store `digital_goods`: e.g. gift cards, `digital_tickets`: Travel and event tickets, not shipped `other_verified`: Other e-media subscriptions.
`consumerShippingAddressFirstUseDate`
Data	Value
Within fingerprint	Required if used
Data type	Numeric with special characters, fixed 10
Description	Date that the consumer first used this shipping address in the shop. Accepted format: `DD.MM.YYYY`.

Shopping Basket Data

Parameters that allow passing on detailed information about the content of a consumer’s shopping basket. By default are optional, but some specific payment methods like invoice or installment are required.

Although the following parameters are optional, all parameters need to be set, except for basketItem(n)Description and basketItem(n)ImageUrl which remain optional.

Table 14. Shopping Basket Data
Parameter	Within fingerprint	Data type	Description
`basketItems`	Required	Numeric	Number of items in the shopping basket.
`basketItem(n)ArticleNumber`	Required	Alphanumeric with special characters	Unique ID of article n in shopping basket.
`basketItem(n)Description`	Required	Alphanumeric with special characters	Product description of article n in the shopping basket.
`basketItem(n)ImageUrl`	Required	Alphanumeric with special characters	URL to an image of each item.
`basketItem(n)Name`	Required	Alphanumeric with special characters	Product name of article n in the shopping basket.
`basketItem(n)Quantity`	Required	Numeric	Items count of article n in the shopping basket.
`basketItem(n)UnitGrossAmount`	Required	Amount	Price per unit of article n in the shopping basket with taxes.
`basketItem(n)UnitNetAmount`	Required	Amount	Price per unit of article n in shopping basket without taxes.
`basketItem(n)UnitTaxAmount`	Required	Amount	Tax amount per unit of article n in shopping basket.
`basketItem(n)UnitTaxRate`	Required	Percentage of tax, e.g. 20 or 19.324. Up to 3 fractions	Percentage of tax per unit of article n in shopping basket.

Table 15. Shopping Basket Data
`basketItems`
Data	Value
Within fingerprint	Required if used
Data type	Numeric
Description	Number of items in the shopping basket.
`basketItem(n)ArticleNumber`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters
Description	Unique ID of article n in shopping basket.
`basketItem(n)Description`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters
Description	Product description of article n in the shopping basket.
`basketItem(n)ImageUrl`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters
Description	URL to an image of each item.
`basketItem(n)Name`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric with special characters
Description	Product name of article n in the shopping basket.
`basketItem(n)Quantity`
Data	Value
Within fingerprint	Required if used
Data type	Numeric
Description	Items count of article n in the shopping basket.
`basketItem(n)UnitGrossAmount`
Data	Value
Within fingerprint	Required if used
Data type	Amount
Description	Price per unit of article n in the shopping basket with taxes.
`basketItem(n)UnitNetAmount`
Data	Value
Within fingerprint	Required if used
Data type	Amount
Description	Price per unit of article n in shopping basket without taxes.
`basketItem(n)UnitTaxAmount`
Data	Value
Within fingerprint	Required if used
Data type	Amount
Description	Tax amount per unit of article n in shopping basket.
`basketItem(n)UnitTaxRate`
Data	Value
Within fingerprint	Required if used
Data type	Percentage of tax, e.g. 20 or 19.324. Up to 3 fractions
Description	Percentage of tax per unit of article n in shopping basket.

Set possible shipping costs as a separate basketItem; otherwise, the validation of the sum of the individual items and the total sum will fail. If different shipping costs apply to the different articles in the basket, the individual shipping costs must be stated as separate basketItem.

Example of basket parameters for a shopping basket

The following simple example is intended to contribute to a better understanding of how to set the basket parameters.

Table 16. Shopping Basket of the Consumer
Quantity	Description	Number	Price per unit	Tax per unit
1	Product A1	A001	EUR 10,80	EUR 1,80
2	Product A2	A002	EUR 14,94	EUR 2,49
3	Shipping	S001	EUR 5,90	EUR 0,0

The parameters for describing the items in the shopping basket of the consumer would be:

Table 17. Parameters for describing the items
Parameter	Value	Description
`basketItems`	3	3 different products in shopping basket
`basketItem1ArticleNumber`	A001
`basketItem1Quantity`	1
`basketItem1Name`	Product A1
`basketItem1UnitGrossAmount`	10,80	Gross price per item 1
`basketItem1UnitNetAmount`	9,00	Net price per item 1
`basketItem1UnitTaxAmount`	1,80	Tax for item 1
`basketItem1UnitTaxRate`	20,000	Tax rate for item 1
`basketItem2ArticleNumber`	A002
`basketItem2Quantity`	2
`basketItem2Name`	Product A2
`basketItem2UnitGrossAmount`	14,94	Gross price per item 2
`basketItem2UnitNetAmount`	12,45	Net price per item 2
`basketItem2UnitTaxAmount`	2,49	Tax for item 2
`basketItem2UnitTaxRate`	20,000	Tax rate for item 2
`basketItem3ArticleNumber`	S001
`basketItem3Quantity`	1
`basketItem3Name`	Shipping
`basketItem3UnitGrossAmount`	5,90	Gross price per item 3
`basketItem3UnitNetAmount`	5,90	Net price per item 3
`basketItem3UnitTaxAmount`	0,0	Tax for item 3
`basketItem3UnitTaxRate`	0,000	Tax rate for item 3

Table 18. Parameters for describing the items
`BASKET_ITEMS`
Data	3
Description	3 different products in the shopping basket
`BASKET_ITEM_1_ARTICLE_NUMBER`
Data	A001
Description
`BASKET_ITEM_1_QUANTITY`
Data	1
Description
`BASKET_ITEM_1_NAME`
Data	Product A1
Description
`BASKET_ITEM_1_UNIT_GROSS_AMOUNT`
Data	10,80
Description	Gross price per item 1
`BASKET_ITEM_1_UNIT_NET_AMOUNT`
Data	9,00
Description	Net price per item 1
`BASKET_ITEM_1_UNIT_TAX_AMOUNT`
Data	1,80
Description	Tax for item 1
`BASKET_ITEM_1_UNIT_TAX_RATE`
Data	20,000
Description	Tax rate for item 1
`BASKET_ITEM_2_ARTICLE_NUMBER`
Data	A002
Description
`BASKET_ITEM_2_QUANTITY`
Data	2
Description
`BASKET_ITEM_2_NAME`
Data	Product A2
Description
`BASKET_ITEM_2_UNIT_GROSS_AMOUNT`
Data	14,94
Description	Gross price per item 2
`BASKET_ITEM_2_UNIT_NET_AMOUNT`
Data	12,45
Description	Net price per item 2
`BASKET_ITEM_2_UNIT_TAX_AMOUNT`
Data	2,49
Description	Tax for item 2
`BASKET_ITEM_2_UNIT_TAX_RATE`
Data	20,000
Description	Tax rate for item 2
`BASKET_ITEM_3_ARTICLE_NUMBER`
Data	S001
Description
`BASKET_ITEM_3_QUANTITY`
Data	1
Description
`BASKET_ITEM_3_NAME`
Data	Shipping
Description
`BASKET_ITEM_3_UNIT_GROSS_AMOUNT`
Data	5,90
Description	Gross price per item 3
`BASKET_ITEM_3_UNIT_NET_AMOUNT`
Data	5,90
Description	Net price per item 3
`BASKET_ITEM_3_UNIT_TAX_AMOUNT`
Data	0,0
Description	Tax for item 3
`BASKET_ITEM_3_UNIT_TAX_RATE`
Data	0,000
Description	Tax rate for item 3

Feature-Specific Parameters

These optional parameters enhance the functionality and usability of the payment process regarding specific features and functions. To enable these parameters, contact our integration specialists.

Table 19. Checkout Page and Checkout Seamless
Parameter	Within fingerprint	Data type	Description
`autoDeposit`	Required	`yes` or `no`	Enable automated debiting of payments.
`confirmMail`	Required	Alphanumeric with special characters, up to 127.	One payment confirmation mail address for the merchant.
`shopId`	Required	Alphanumeric, up to 16.	Unique ID of the online shop within the customer ID to enable various configurations of the online shop.

Table 20. Checkout Page and Checkout Seamless
`autoDeposit`
Data	Value
Within fingerprint	Required if used.
Data type	`yes` or `no`
Description	Enable automated debiting of payments.
`confirmMail`
Data	Value
Within fingerprint	Required if used.
Data type	Alphanumeric with special characters, up to 127.
Description	One payment confirmation mail address for the merchant.
`shopId`
Data	Value
Within fingerprint	Required if used.
Data type	Alphanumeric, up to 16.
Description	Unique ID of the online shop within the customer ID to enable various configurations of the online shop.

Display or edit consumer data

This feature allows the consumer to enter his shipping or billing information after opening the payment link. Contact our integration specialists to enable the feature.

Table 21. Basket Items
Parameter	Within fingerprint	Data type	Description
`displayBasketData`	Optional	Enumeration	`Y`- Display Basket Items on Checkout Page.
`displayBasketData`	Optional	Enumeration	`N`- Don’t display Basket Items.

Table 22. Basket Items
`displayBasketData`
Data	Value
Within fingerprint	Optional
Data type	Enumeration
Description	`Y`- Display Basket Items on Checkout Page. `N`- Don’t display Basket Items.

Provide basket items to init or via PayByLink. Items or amounts can’t be changed by the consumer afterward.

Table 23. Shipping Data
Parameter	Within fingerprint	Data type	Description
`displayShippingData`	Optional	Enumeration	`E`: Editable. Let consumer edit Shipping Data.
			`Y`: Display only. (If provided by merchant)
			`N`: Don’t display consumer’s Shipping Data.

Table 24. Shipping Data
`displayShippingData`
Data	Value
Within fingerprint	Optional
Data type	Enumeration
Description	`E`: Editable. Let consumer edit Shipping Data. `Y`: Display only. (If provided by merchant) `N`: Don’t display consumer’s Shipping Data.

If set to Y the merchant must provide the Shipping Data to display during init or via PayByLink.

Table 25. Billing Data
Parameter	Within fingerprint	Data type	Description
`displayBillingData`	Optional	Enumeration	`E`: Editable. Let consumer edit Billing Data.
			`Y`: Display only. (If provided by merchant)
			`N`: Don’t show consumer’s Billing Data.

Table 26. Billing Data
`displayBillingData`
Data	Value
Within fingerprint	Optional
Data type	Enumeration
Description	`E`: Editable. Let consumer edit Billing Data. `Y`: Display only. (If provided by merchant) `N`: Don’t show consumer’s Billing Data.

If no billing data is sent to init but shipping Data is, then a consumer can choose to use shipping data as billing data.

If any of displayBasket, displayBillingData, displayShippingData is set to Y or E an additional return parameter will be received during confirmation that contains the consumer’s information.

Table 27. Additionally for Checkout Page
Parameter	Within fingerprint	Data type	Description
`maxRetries`	Required	Numeric	Maximum number of payment attempts for the same order.
`paymenttypeSortOrder`	Optional	Enumeration/list	Sort order of payment methods and sub-methods if the consumer uses `SELECT` as payment method.

Table 28. Additionally for Checkout Page
`maxRetries`
Data	Value
Within fingerprint	Required if used.
Data type	Numeric
Description	Maximum number of payment attempts for the same order.
`paymenttypeSortOrder`
Data	Value
Within fingerprint	Optional
Data type	Enumeration/list
Description	Sort order of payment methods and sub-methods if the consumer uses `SELECT` as payment method.

Restrictions for Payment Methods

Table 29. Restrictions of parameter customerStatement
Acquirer	Brand	Data type
American Express	American Express	ASCII, up to 254 characters
B+S	Mastercard, Visa	ASCII, up to 254 characters
card complete	Maestro SecureCode, Mastercard, Visa	Alphanumeric, up to 25 characters.
ConCardis	Maestro SecureCode, Mastercard, Visa	ASCII, up to 254 characters.
b4payment	b4payment	ASCII, up to 254 characters.
DC Bank	Diners Club	ASCII, up to 254 characters
EPS	EPS	"a-z" "A-Z" ""0-9" "/-?:().,'+", up to 35 characters (Depending on the chosen Option),
Giropay	Giropay	ASCII, up to 254 characters.
Hobex	Maestro SecureCode, Mastercard, Visa	`customerStatement` is not used and the name of the merchant is always displayed on the consumer’s bank statement.
Hobex	SEPA Direct Debit	ASCII, up to 254 characters.
iDeal	iDeal	ASCII (without < > % &) with a variable length of up to 32 characters.
Klarna	Sofort	ASCII, up to 254 characters.
Klarna	Klarna	ASCII, up to 254 characters.
PayPal	PayPal	ASCII, up to 254 characters.
Przelewy24	Przelewy24	ASCII, up to 25 characters.
paysafecard	paysafecard	ASCII, up to 254 characters.
payolution	payolution	ASCII, up to 254 characters.
Riverty	Riverty	ASCII, up to 254 characters
SIX Pay	Maestro SecureCode, Mastercard, Visa	ASCII, up to 254 characters
SIX Payment Services	Maestro SecureCode, Mastercard, Visa	ASCII, up to 254 characters
Sofort	Sofort	ASCII, up to 254 characters
Worldline	Maestro SecureCode, Mastercard, Visa	Alphanumeric with special characters, up to 22 characters

Table 30. Restrictions for Parameters orderReference and `merchantReference`:
Acquirer	Brand	Data type
American Express	American Express	Not supported
B+S	Mastercard, Visa	Not supported
ConCardis	Mastercard, Visa	Not supported
card complete	Maestro SecureCode, Mastercard, Visa	Alphanumeric, up to 25 characters.
b4payment	b4payment	ASCII, up to 128 characters.
DC Bank	Diners Club	ASCII, up to 128 characters
Eps	Eps	ASCII, up to 35 characters.
Giropay	Giropay	Variable, up to 32 characters. Allowed characters are [0-9a-zA-Z].
Hobex	SEPA Direct Debit	ASCII, up to 128 characters.
Hobex	Maestro SecureCode, Mastercard, Visa	Alphanumeric, up to 20 characters
iDeal	iDeal	Alphanumeric with a variable length of up to 32 characters.
Klarna	Klarna	ASCII, up to 254 characters.
Przelewy24	Przelewy24	ASCII, up to 64 characters.
paysafecard	paysafecard	ASCII, up to 128 characters.
payolution	payolution	ASCII, up to 128 characters.
PayPal	PayPal	ASCII, up to 128 characters.
Riverty	Riverty	ASCII, up to 254 characters
SIX Payment Services	Maestro SecureCode, Mastercard, Visa	Not supported
SIX Pay	Maestro SecureCode, Mastercard, Visa	Not supported
Sofort	Sofort	ASCII, up to 254 characters
Wordline ^[1] 1. The parameter `orderReference` becomes mandatory if Worldline as an acquirer is used.	Maestro SecureCode, Mastercard, Visa	Numeric and special characters between 10 and 64 characters.

SEPA

Table 31. SEPA
Parameter	Within fingerprint	Data type	Short description
`mandateId`	Required	Alphanumeric, up to 35.	Identifier of displayed mandate.
`mandateSignatureDate`	Required	Date as `DD.MM.YYYY`.	Date when mandate was signed.

Table 32. SEPA
`mandateId`
Data	Value
Within fingerprint	Required if used
Data type	Alphanumeric, up to 35.
Short description	Identifier of displayed mandate.
`mandateSignatureDate`
Data	Value
Within fingerprint	Required if used
Data type	Date as `DD.MM.YYYY`.
Short description	Date when mandate was signed.

If mandateId is not set hobex Service IT will generate it and if mandateSignatureDate is not set hobex Service IT will use the current date as a signature date.

GooglePay

Parameter Within fingerprint Data type Description

Parameter	Within fingerprint	Data type	Description
`shippingAddressRequired`	Optional	Numeric	Can be activated with value "1"
`phoneNumberRequired`	Optional	Numeric	Can be activated with value "1"
`allowedCountryCodes`	Optional	Enumeration	Eg. value '["AT","DE","CH"]' allowes only Austria, Germany and Switzerland.

shippingAddressRequired

Optional

Numeric

Can be activated with value "1"

phoneNumberRequired

Optional

Numeric

Can be activated with value "1"

allowedCountryCodes

Optional

Enumeration

Eg. value '["AT","DE","CH"]' allowes only Austria, Germany and Switzerland.

Table 33. allowedCardNetworks
Parameter	Within fingerprint	Data type	Description
`allowedCardNetworks`	Optional	Enumeration	`AMEX`: American Express `DISCOVER`: Discover `DINERS`: Diners Club `MASTERCARD`: Mastercard `VISA`: Visa

allowedCardNetworks is for CheckoutPage only

Table 34. paymentToken
Parameter	Within fingerprint	Data type	Description
`paymentToken`	Optional	Alphanumeric, up to 2000 digits	PaymentToken from GooglePay that needs to be send to hobex in order to process the payment with the respctive acquirer.

paymentToken is only for CheckoutSeamless and becomes mandatory if GooglePay is used

additionalMerchantData

Table 35. AdditionalMerchantData
Acquirer	Parameter	Within fingerprint	Data type	Description
`Klarna`	additionalMerchantData	Optional	Alphanumeric, base64	The value of the attachment.body base64 encoded. NOTE: Value of 'attachment.content_type' is NOT required.