Optional Parameters
Optional Parameters
Highly Recommended
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
Required if used |
Alphanumeric with special characters |
URL of your online shop where QENTA sends a server-to-server confirmation |
|
Required if used |
Alphanumeric with special characters, up to 254 characters |
Text displayed on bank statement issued to your consumer by the financial service provider. |
|
Required if used |
Alphanumeric with special characters, up to 128 characters |
Unique order reference ID sent from merchant to financial institution. Correlate the order numbers of your online shop with the affected payments. |
|
Optional |
Alphanumeric with special characters |
URL of your 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. |
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
Optional |
Alphanumeric with special characters |
URL of your online shop where your information page regarding deactivated JavaScript resides |
|
Required if used |
Numeric, up to 9 |
Order number of payment |
|
Optional |
Alphanumeric |
Window name of browser window where payment page is opened. |
|
Required if used |
Boolean |
Check for duplicate requests done by your consumer. |
|
Required if used |
Enumeration |
Possible values are |
|
Optional |
URL |
URL to a CSS file on your server to perform customizations |
|
|
Required if used |
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: |
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
Optional |
Alphanumeric with special characters |
Text displayed to your consumer during the payment process. |
|
Optional |
Alphanumeric with special characters |
URL of your online shop where your online shop logo is located. |
|
Optional |
Alphanumeric |
Hex code RGB color value as background color for the brand image containing the credit card logos. |
|
Optional |
Enumeration |
Sub-selection of financial institutions regarding the pre-selected payment method. |
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
Required if used |
Alphanumeric with special characters |
Unique ID of order which has to be the same as used for initiating the Data Storage. |
|
Required if used |
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 your consumer and some specific payment methods are required.
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
Required if used |
Alphanumeric with special characters, up to 256 characters |
E-mail address of the consumer. |
|
Required if used |
Numeric with special characters, fixed-length 10 |
Birth date of the consumer in the format |
|
Required if used |
Alphanumeric with special characters, up to 32 characters |
Tax identification number of consumer. |
|
Required if used |
Alphanumeric with special characters, up to 32 characters |
Drivers license number of consumer. |
|
Required if used |
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. |
|
Required if used |
Alphabetic, fixed length of 2 characters |
Country which issued the drivers license of consumer. |
|
Required if used |
Alphanumeric, up to 50 characters |
Unique ID identifying the consumer of your online shop. The parameter must not be a human-readable e-mail address. |
|
Required if used |
Enumeration |
Type of consumer login in your shop. Accepted values: |
|
Required if used |
Timestamp |
Date and time of the consumer login to your shop. Accepted format: |
|
Required if used |
Numeric with special characters, fixed length of 10 |
Date that the consumer’s card was added to their account in your shop for card-on-file payments. Accepted format: |
|
Required if used |
Numeric, up to 9 characters |
Number of cards the consumer has attempted to add to their account in your shop for card-on-file payments in the past 24 hours. |
|
Required if used |
Enumeration |
Specifies whether transaction shall be subject to Strong Customer Authentication (SCA). |
|
Required if used |
Boolean |
Indicates if you have experienced suspicious activities by the consumer. |
|
Required if used |
Enumeration |
Delivery time frame. Accepted values: |
|
Required if used |
Numeric with special characters, fixed length of 10 |
The expected date that the item will be available for a pre-ordered purchase. Accepted format: |
|
Required if used |
Enumeration |
Indicates if the consumer is reordering previously purchased items. Accepted values: |
|
Required if used |
Numeric with special characters, fixed length of 10 |
Registration date of the consumer’s account in your shop. Accepted format: |
|
Required if used |
Numeric with special characters, fixed length of 10 |
Date that the consumer last made changes to their account in your shop. |
|
Required if used |
Numeric with special characters and a fixed length of 10 |
Date that the consumer last changed/reset their password in your shop. Accepted format: |
|
Required if used |
Numeric, up to 9 characters |
Number of successful orders by the consumer in your shop within the past six months. |
|
Required if used |
Numeric, up to 9 characters |
Number of transactions that the consumer has attempted in the past 24 hours. Does not include merchant-initiated transactions. |
|
Required if used |
Numeric, up to 9 characters |
Number of transactions that the consumer has attempted in the past year. Does not include merchant-initiated transactions. |
Consumer Billing Data
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
Required if used |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes |
First name of consumer. |
|
Required if used |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes |
Last name of consumer. |
|
Required if used |
Alphanumeric, up to 100 bytes |
Name of the street and optionally the house number. |
|
Required if used |
Alphanumeric, up to 100 bytes |
The house number if not already set in |
|
Required if used |
Alphanumeric, up to 100 bytes |
Further details regarding consumer’s address. |
|
Required if used |
Alphanumeric, up to 32 bytes |
Billing city |
|
Required if used |
If the |
Billing state |
|
Required if used |
Alphabetic, fixed 2 characters |
Billing country code ISO 3166-1. |
|
Required if used |
Alphanumeric, up to 12 characters |
Billing zip code. |
|
Required if used |
Alphanumeric, up to 20 characters |
Phone number of consumer. |
|
Required if used |
Alphanumeric, up to 18 characters |
Mobile phone number of consumer. |
|
Required if used |
Alphanumeric, up to 20 characters |
Fax number of consumer. |
Consumer Shipping Data
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
Required if used |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes |
First name of the consumer. |
|
Required if used |
First character has to be alphabetic, any other characters ASCII, up to 30 bytes |
Last name of the consumer. |
|
Required if used |
Alphanumeric, up to 100 bytes |
Name of the street and optionally the house number. |
|
Required if used |
Alphanumeric, up to 100 bytes |
The house number if not already set in |
|
Required if used |
Alphanumeric, up to 32 bytes |
Shipping city. |
|
Required if used |
If the |
Shipping state. |
|
Required if used |
Alphabetic, fixed 2 characters |
Shipping country code ISO 3166-1. |
|
Required if used |
Alphanumeric, up to 12 |
Shipping ZIP code. |
|
Required if used |
Alphanumeric, up to 20 |
Shipping phone number. |
|
Required if used |
Alphanumeric, up to 20 |
Shipping fax number. |
|
Required if used |
Enumeration |
Indicates whether consumer is placing an order for an item which is not yet available or which is currently available. |
|
Required if used |
Enumeration |
Shipping method chosen by the consumer. Accepted values: |
|
Required if used |
Numeric with special characters, fixed 10 |
Date that the consumer first used this shipping address in your shop. |
Shopping Basket Data
Parameters that allow you to pass on detailed information about the content of your consumer’s shopping basket. By default are optional, but for 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.
|
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 .
|
Exemple 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.
The parameters for describing the items in the shopping basket of your consumer would be:
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.
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
|
Required if used. |
|
Enable automated debiting of payments. |
|
Required if used. |
Alphanumeric with special characters, up to 127. |
One payment confirmation mail address for the merchant. |
|
Required if used. |
Alphanumeric, up to 16. |
Unique ID of your online shop within your customer ID to enable various configurations of your online shop. |
Display or edit consumer data
This feature allows your consumer to enter his shipping or billing information after opening the payment link. Contact our integration specialists to enable the feature.
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
|
Optional |
Enumeration |
|
|
Provide basket items to init or via payByLink. Items or amounts can’t be changed by the consumer afterwards. |
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
|
Optional |
Enumeration |
|
|
|||
|
If set to Y the merchant must provide the Shipping Data to display during init or via PayByLink.
|
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
|
Optional |
Enumeration |
|
|
|||
|
If no billing data is sent to init but shipping Data is, then consumer can choose to use shipping data as billing data. |
If any of displayBasket
, displayBillingData
, displayShippingData
is set to Y
or E
you receive an additional return parameter during confirmation that contains the consumer’s information.
Parameter | Within fingerprint | Data type | Description |
---|---|---|---|
|
Required if used. |
Numeric |
Maximum number of payment attempts for the same order. |
|
Optional |
Enumeration/list |
Sort order of payment methods and sub-methods if your consumer uses |
Restrictions for Payment Methods
Acquirer | Brand | Data type |
---|---|---|
Afterpay |
AfterPay |
ASCII, up to 254 characters |
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 |
ASCII, up to 254 characters. |
Giropay |
Giropay |
ASCII, up to 254 characters. |
Hobex |
Maestro SecureCode, Mastercard, Visa |
|
Hobex |
SEPA Direct Debit |
ASCII, up to 254 characters. |
Klarna |
Sofort |
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. |
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 |
Acquirer | Brand | Data type |
---|---|---|
Afterpay |
AfterPay |
ASCII, up to 254 characters |
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 |
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. |
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 |
Maestro SecureCode, Mastercard, Visa |
Numeric and special characters between 10 and 64 characters. |
SEPA
Parameter | Within fingerprint | Data type | Short description |
---|---|---|---|
Required if used |
Alphanumeric, up to 35. |
Identifier of displayed mandate. |
|
Required if used |
Date as |
Date when mandate was signed. |
If mandateId is not set QENTA will generate it and if mandateSignatureDate is not set QENTA will use the current date as signature date.
|