Data Storage Parameters

Request Parameters

To initialize the hobex Data Storage the merchant has to set all required parameters to their corresponding values that are needed within the online shop. If one or more of these required parameters are missing an error message will be accrued.

Table 1. Initialization of hobex Data Storage
Parameter	Data type	Description
`customerId`	Alphanumeric, fixed 7	Unique ID of merchant.
`orderIdent`	Alphanumeric	Unique reference to the order of the consumer.
`returnUrl`	Alphanumeric	Return URL for outdated browsers.
`language`	Alphabetic, fixed 2.	Language for returned texts and error messages.
`requestFingerprint`	Alphanumeric, 128.	Computed fingerprint of the parameter values and the secret.

Table 2. Initialization of hobex Data Storage
`customerId`
Data	Value
Data type	Alphanumeric, fixed 7
Description	Unique ID of merchant.
`orderIdent`
Data	Value
Data type	Alphanumeric
Description	Unique reference to the order of the consumer.
`returnUrl`
Data	Value
Data type	Alphanumeric
Description	Return URL for outdated browsers.
`language`
Data	Value
Data type	Alphabetic, fixed 2.
Description	Language for returned texts and error messages.
`requestFingerprint`
Data	Value
Data type	Alphanumeric, 128.
Description	Computed fingerprint of the parameter values and the secret.

Table 3. Credit Card, Mail Order and Telephone Order, and MaestroSecureCode
Parameter	Data type	Description
`pan`	Numeric, length of 13 to 19	Credit card number.
`expirationMonth`	Numeric, fixed 2	Expiration month of credit card.
`expirationYear`	Numeric, fixed 2	Expiration year of credit card.

Table 4. SEPA Direct Debit
Parameter	Data type	Description
`accountOwner`	Alphanumeric with special characters.	Name of owner of account.
`bankAccountIban`	Alphanumeric, up to 34 characters.	IBAN of account.
`bankBic`	Alphanumeric, up to 12 characters.	BIC of bank. Required only for Hobex

Table 5. Initialization of hobex Data Storage GooglePay
Parameter	Data type	Short description
`googlepaymerchantid`	Alphanumeric, 16	Unique ID of hobex. Will be provided by hobex.
`googlepaymerchantname`	Alphanumeric	Unique Name for the Merchant. Will be provided by hobex.
`googlepayallowedauthmethod`	Enumeration	Value must be forwareded as = "PAN_ONLY", "CRYPTOGRAM_3DS"
`googlepayallowedcardnetwork`	Enumeration	Supported Brands for GooglePay. Eg.: If AMEX, VISA and Mastercard should be accepted use as value = AMEX","MASTERCARD","VISA". Brands and GooglePay needs to be supported by the credit card acquirer. Available Brands will be provided by hobex.
`googlepaycurrencycode`	Alphabetic	Currency
`googlepaycountrycode`	Alphabetic	ISO 3166-1. Will be provided by hobex.
`googlepaytotalprice`	Numeric	Total amount, only a dot(.) allowed as seperator.
`javascriptScriptVersion`	Alphanumeric, fixed 9 characters	The value `googlepay` must be set to allow the rendering of googlePay.

Table 6. optional for Reading Stored Payment Data from hobex Data Storage
Parameter	Data type	Short description
`customerId`	Alphanumeric, fixed 7	Unique ID of merchant.
`storageId`	Alphanumeric, fixed 32	Unique ID of Data Storage.
`requestFingerprint`	Alphanumeric, fixed 128	Computed fingerprint of the parameter values and the secret.

Table 7. optional for Initialization of hobex Data Storage
Parameter	Data type	Description
`shopId`	Alphanumeric with a variable length of 16	Unique ID of the online shop.
`javascriptScriptVersion`	Alphanumeric, fixed 4 characters	The value `pci3` must be set to allow the input of credit card-related data in the displayed iframe.

Table 8. optional for Initialization of hobex Data Storage
`shopId`
Data	Value
Data type	Alphanumeric with a variable length of 16
Description	Unique ID of the online shop.
`javascriptScriptVersion`
Data	Value
Data type	Alphanumeric, fixed 4 characters
Description	The value `pci3` must be set to allow the input of credit card-related data in the displayed iframe.

Table 9. optional for Credit Card, Mail Order and Telephone Order, and MaestroSecureCode.
Parameter	Data type	Description
`cardholdername`	Alphanumeric, up to 30.	Name of owner of a credit card.
`cardverifycode`	Numeric, of 1 to 4.	Verification code of a credit card.
`issueMonth`	Numeric, fixed 2.	Issuing month of a credit card.
`issueYear`	Numeric, fixed 2.	Issuing year of a credit card.
`issueNumber`	Numeric, of 1 to 3.	Issuing number of a credit card.

Table 10. optional for SEPA Direct Debit
Parameter	Data type	Description
`bankName`	Alphanumeric with special characters.	Name of the bank.

Table 11. Reading Stored Payment Data from hobex Data Storage
Parameter	Data type	Short description
`shopId`	Alphanumeric, 16	Unique ID of the online shop.

Table 12. PCI DSS SAQ A Compliance
Parameter	Data type	Description
`iframeCssUrl`	URL	URL to a CSS file on the server to perform customizations of the iframe input fields.
`creditcardPanPlaceholder`	Alphanumeric, 32 characters	Placeholder text for the credit card number field.
`creditcardCvcPlaceholder`	Alphanumeri, 32 characters	Placeholder text for the credit card verification number field.
`creditcardCardholderNamePlaceholder`	Alphanumeric, 32 characters	Placeholder text for the credit cardholder field.
`creditcardIssueNumberPlaceholder`	Alphanumeric, 32 characters	Placeholder text for the credit card issue number.
`creditcardShowExpirationDatePlaceholder`	Boolean	Display placeholder text for the credit card expiration date.
`creditcardShowIssueDatePlaceholder`	Boolean	Display placeholder text for the credit card issue date.
`creditcardShowCardholderNameField`	Boolean	Display field containing cardholder name.
`creditcardShowCvcField`	Boolean	Display CVC field.
`creditcardShowIssueDateField`	Boolean	Display field containing the card issue date.
`creditcardShowIssueNumberField`	Boolean	Display field containing the card issue number.

Table 13. PCI DSS SAQ A Compliance
`iframeCssUrl`
Data	Value
Data type	URL
Description	URL to a CSS file on the server to perform customizations of the iframe input fields.
`creditcardPanPlaceholder`
Data	Value
Data type	Alphanumeric, 32 characters
Description	Placeholder text for the credit card number field.
`creditcardCvcPlaceholder`
Data	Value
Data type	Alphanumeric, 32 characters
Description	Placeholder text for the credit card verification number field.
`creditcardCardholderNamePlaceholder`
Data	Value
Data type	Alphanumeric, 32 characters
Description	Placeholder text for the credit cardholder field.
`creditcardIssueNumberPlaceholder`
Data	Value
Data type	Alphanumeric, 32 characters
Description	Placeholder text for the credit card issue number.
`creditcardShowExpirationDatePlaceholder`
Data	Value
Data type	Boolean
Description	Display placeholder text for the credit card expiration date.
`creditcardShowIssueDatePlaceholder`
Data	Value
Data type	Boolean
Description	Display placeholder text for the credit card issue date.
`creditcardShowCardholderNameField`
Data	Value
Data type	Boolean
Description	Display field containing cardholder name.
`creditcardShowCvcField`
Data	Value
Data type	Boolean
Description	Display CVC field.
`creditcardShowIssueDateField`
Data	Value
Data type	Boolean
Description	Display field containing the card issue date.
`creditcardShowIssueNumberField`
Data	Value
Data type	Boolean
Description	Display field containing the card issue number.

These fields must not be included in the fingerprint calculation.

Response Parameters

Table 14. Initialization of hobex Data Storage
Parameter	Data type	Description
`storageId`	Alphanumeric, fixed 32.	Unique ID of the online shop.
`javascriptUrl`	Alphanumeric	Version number of JavaScript.

Table 15. Credit Card, Mail Order and Telephone Order, and MaestroSecureCode.
Parameter	Data type	Description
`anonymousPan`	Numeric, fixed 4.	Anonymized credit card number containing only the rightmost 4 digits.
`maskedPan`	Numeric with special characters and a variable length of 13 to 19.	Masked credit card number: first 6 numbers followed by `*` and last 4 numbers of the credit card.
`financialInstitution`	Enumeration	Financial institution
`brand`	Enumeration	Brand depending on payment method.
`cardholdername`	Alphanumeric with special characters.	Name of the cardholder.
`expiry`	Numeric with special characters.	Expiry date of credit card in the format `MM/YYYY`.

Table 16. Credit Card, Mail Order and Telephone Order, and MaestroSecureCode.
`anonymousPan`
Data	Value
Data type	Numeric, fixed 4.
Description	Anonymized credit card number containing only the rightmost 4 digits.
`maskedPan`
Data	Value
Data type	Numeric with special characters and a variable length of 13 to 19.
Description	Masked credit card number: first 6 numbers followed by `*` and last 4 numbers of the credit card.
`financialInstitution`
Data	Value
Data type	Enumeration
Description	Financial institution
`brand`
Data	Value
Data type	Enumeration
Description	Brand depending on payment method.
`cardholdername`
Data	Value
Data type	Alphanumeric with special characters.
Description	Name of the cardholder.
`expiry`
Data	Value
Data type	Numeric with special characters.
Description	Expiry date of credit card in the format `MM/YYYY`.

Table 17. Reading Stored Payment Data from hobex Data Storage
Parameter	Data type	Description
`storageId`	Alphanumeric, fixed 32.	Unique ID of Data Storage.
`paymentInformations`	Numeric	Number of stored payment methods.
`paymentInformation.{n}.paymentType`	Alphabetic	Name of payment method.

Table 18. Reading Stored Payment Data from hobex Data Storage
`storageId`
Data	Value
Data type	Alphanumeric, fixed 32.
Description	Unique ID of Data Storage.
`paymentInformations`
Data	Value
Data type	Numeric
Description	Number of stored payment methods.
`paymentInformation.{n}.paymentType`
Data	Value
Data type	Alphabetic
Description	Name of payment method.

Table 19. Returned Payment Method Specific Parameters
Parameter	Data type	Description
`paymentInformation.{n}.anonymousPan`	Numeric with a fixed length of 4.	Anonymized credit card number containing only the rightmost 4 digits.
`paymentInformation.{n}.maskedPan`	Numeric with special characters and a variable length of 13 to 19.	Masked credit card number: first 6 numbers followed by `*` and the last 4 numbers of the credit card.
`paymentInformation.{n}.financialInstitution`	Enumeration	Financial institution.
`paymentInformation.{n}.brand`	Enumeration	Brand of Credit Card.
`paymentInformation.{n}.cardholdername`	Alphanumeric with special characters.	Name of the cardholder.
`paymentInformation.{n}.expiry`	Numeric with special characters.	Expiry date of credit card in the format `MM/YYYY`.
`paymentInformation.{n}.accountOwner`	Alphanumeric with special characters.	Name of the owner of the account.
`paymentInformation.{n}.bankName`	Alphanumeric with special characters.	Name of the bank.
`paymentInformation.{n}.bankCountry`	Alphabetic with a fixed length of 2.	Country code of the bank.
`paymentInformation.{n}.bankAccount`	Alphanumeric with a variable length of 1 to 11.	Account number.
`paymentInformation.{n}.bankNumber`	Numeric with a variable length of 1 to 8.	Bank number.
`paymentInformation.{n}.bankBic`	Alphanumeric with a variable length of 1 to 255.	BIC of the bank.
`paymentInformation.{n}.bankAccountIban`	Alphanumeric with a variable length of 1 to 255.	IBAN of account.

Table 20. Returned Payment Method Specific Parameters
`paymentInformation.{n}.anonymousPan`
Data	Value
Data type	Numeric with a fixed length of 4.
Description	Anonymized credit card number containing only the rightmost 4 digits.
`paymentInformation.{n}.maskedPan`
Data	Value
Data type	Numeric with special characters and a variable length of 13 to 19.
Description	Masked credit card number: first 6 numbers followed by `*` and the last 4 numbers of the credit card.
`paymentInformation.{n}.financialInstitution`
Data	Value
Data type	Enumeration
Description	Financial institution.
`paymentInformation.{n}.brand`
Data	Value
Data type	Enumeration
Description	Brand of Credit Card.
`paymentInformation.{n}.cardholdername`
Data	Value
Data type	Alphanumeric with special characters.
Description	Name of the cardholder.
`paymentInformation.{n}.expiry`
Data	Value
Data type	Alphanumeric with special characters.
Description	Expiry date of credit card in the format `MM/YYYY`.
`paymentInformation.{n}.accountOwner`
Data	Value
Data type	Alphanumeric with special characters.
Description	Name of the owner of the account.
`paymentInformation.{n}.bankName`
Data	Value
Data type	Alphanumeric with special characters.
Description	Name of the bank.
`paymentInformation.{n}.bankCountry`
Data	Value
Data type	Alphabetic with a fixed length of 2.
Description	Country code of the bank.
`paymentInformation.{n}.bankAccount`
Data	Value
Data type	Alphanumeric with a variable length of 1 to 11.
Description	Account number.
`paymentInformation.{n}.bankNumber`
Data	Value
Data type	Numeric with a variable length of 1 to 8.
Description	Bank number.
`paymentInformation.{n}.bankBic`
Data	Value
Data type	Alphanumeric with a variable length of 1 to 255.
Description	BIC of the bank.
`paymentInformation.{n}.bankAccountIban`
Data	Value
Data type	Alphanumeric with a variable length of 1 to 255.
Description	IBAN of account.

Be aware that due to PCI DSS compliance, hashedPan can’t be returned either with maskedPan or anonymousPan.