Detailed Description of Parameters

Request Parameters

Required Parameters

amount

With the parameter amount, you need to specify the amount of the payment to be done by the consumer of your online shop. Only dot . or comma , are allowed values as a decimal separator.

A thousand separators are not permitted.

The maximum number of decimal places depends on the selected currency within the currency parameter:

Currency Decimal places

Euro

Maximum of 2 decimal places (100 Cent = 1 Euro).

US Dollar

Maximum of 2 decimal places (100 Cent = 1 US$).

Yen

No decimal places allowed.

Libyan Dinar

Maximum of 3 decimal places (1000 Dirham = 1 Dinar).

cancelUrl

cancelUrl has to contain the URL of the page where your consumer is forwarded when the payment process has been canceled. You should inform your consumer about the cancelation of the payment process and offer possibilities to retry the payment attempt or get in contact with you.

cssUrl

cssUrl contains an URL to a CSS file stored on your server which is accessible from the Internet. The CSS file is used to adjust the responsive design of QMORE Checkout Seamless and QPAY Checkout Page.

currency

With the parameter currency you need to define the currency to be used for the payment.

By default, only EUR is enabled to be used as currency. If you would like to enable additional currencies for your online shop contact our sales team.
Table 1. List of Currencies Based on ISO 4217
Alphabetic value Numeric value Currency

CHF

756

Swiss Franc

CZK

203

Czech Koruna

EUR

978

Euro

GBP

826

Pound Sterling

HUF

348

Hungarian Forint

PLN

985

Polish Zloty

USD

840

US Dollar

Not all available payment methods support all currencies.

customerId

With parameter customerId you need to send the unique ID of the merchant using the QENTA Checkout Server.

Test data

For demo and test mode use the relevant demo and test data.

For production mode you’ll get your personal customerId in conjunction with your secret from our integration specialists.

failureUrl

With the parameter failureUrl you can define the URL of your online shop where your consumer is forwarded when the payment process has failed for some reason. On this page, you should offer possibilities to retry the payment attempt or get in contact with you.

language

With the parameter language you can define the language used for all messages of QPAY Checkout Page and QMORE Checkout Seamless that are displayed to the consumer of your online shop.

By default, only English and German are activated. If the language selected for your online shop is not supported by the respective financial service provider, the financial service provider decides which language is displayed to the consumer.
Table 2. Currently Available Languages
Value Language

ar

Arabian

bs

Bosnian

bg

Bulgarian

zh

Chinese

hr

Croatian

cs

Czech

da

Danish

nl

Dutch

en

English

et

Estonian

fi

Finnish

fr

French

de

German

el

Greek

he

Hebrew

hi

Hindi

hu

Hungarian

it

Italian

ja

Japanese

ko

Korean

lv

Latvian

lt

Lithuanian

mk

Macedonian

no

Norwegian

pl

Polish

pt

Portuguese

ro

Romanian

ru

Russian

sr

Serbian

sk

Slovakian

sl

Slovenian

es

Spanish

sv

Swedish

tr

Turkish

uk

Ukrainian

orderDescription

With orderDescription you need to add a description of what your consumer paid for, e.g. a text cross-referencing the order made in the online shop.

This text is not transmitted to any financial service provider and is therefore NEVER displayed on any consumer’s invoice or statement.

If the optional request parameter displayText is not used the orderDescription text will also be visible as consumer information in QPAY Checkout Page.

The value of orderDescription must not contain any special characters or line breaks. If such characters are included, our fingerprint computation is not identical with yours and the error message "Invalid fingerprint!" is displayed.

paymentType

With paymentType you need to define the value of the payment method the user selected in your online shop.

You can only use those payment methods you have purchased and enabled by QENTA. If you want to offer additional payment methods within your online shop contact our sales team.
Value of parameter paymentType Payment method

SELECT

The consumer may select one of the activated payment methods directly in QPAY Checkout Page.

AFTERPAY

AfterPay

CCARD

Credit Card, Maestro SecureCode

CCARD-MOTO

Credit Card-Mail Order and Telephone Order

CIRCLEK

Circle K

CRYPTO

Crypto

CVSPHARMACY

CVS

DOLLARGENERAL

Dollar General

EPS

EPS

OPENBUCKSCARD

oBucks

INVOICE

Invoice: Payolution

PRZELEWY24

Przelewy24

PAYPAL

PayPal

PSC

Paysafecard

PAGOEFECTIVO

PagoEfectivo

SEPA-DD

SEPA

SOFORTUEBERWEISUNG

Sofort

SAFETYPAY

Safetypay

requestFingerprint

The parameter requestFingerprint has to contain your computed fingerprint based on the parameter values you define in the parameter requestFingerprintOrder. This method is used for security reasons to verify the parameters your online shop sends to the QENTA Checkout Server.

At least one of your parameters used for computing the fingerprint need to be unique to each order to prevent sending the same hash-value!

To authenticate, all requests to the QENTA Checkout Server the HMAC-SHA-512 construction is used by combining the cryptographic hash function SHA-512 with the secret as the cryptographic key to hash the concatenated request parameter values in the order defined in the requestFingerprintOrder.

requestFingerprintOrder

The parameter requestFingerprintOrder has to contain an ordered list of all parameter names separated by comma the values of which are used to create the fingerprint.

You can add the parameter names in any order you want, but you have to adjust the order of the parameter values you use while calculating the fingerprint accordingly, e.g. secret,customerId,amount,currency,language,orderDescription,successUrl,requestFingerprintOrder.

serviceUrl

The parameter serviceUrl is used to define the URL of a web page in your online shop which informs your consumer about the different possibilities to get in contact with you.

Don’t use this URL to link to the shopping basket of your consumer!

If you don’t use the optional parameter imageUrl the serviceUrl is not used in the QPAY Checkout Page and your consumer has no possibility to access your service page in your online shop during the payment process.

URL has to be accessible over the internet via port 80 or port 443 and may not be hosted on a local server that can’t be accessed by the QENTA Checkout Server.

successUrl

With the parameter successUrl you need to define the URL of your online shop where your consumer is forwarded when the payment process has been completed.

merchantTokenizationFlag

With the parameter merchantTokenizationFlag you can set the recurring flaggings for specific orders, so you have to set it to TRUE to save the consumer’s card details for later use.

periodicType

With the parameter periodicType you can set the periodic type of initial and recurring payments.

periodicType value Description

ucof

For unscheduled recurring payments-with different amounts.

recurring

For recurring payments like subscriptions-with same interval and same amount.

returnUrl

returnUrl is used for browsers who are not capable of fully supporting CORS (Cross Origin Resource Sharing). In that case the communciation between the HTML page and the QENTA Checkout Server will be done within an iframe where the anonymized payment data are returned to JavaScript objects.

Optional Parameters

backgroundColor

With the parameter backgroundColor you can set a different background color for the HTML pages in your custom CSS for QPAY Checkout Page, you can also set the background color for the brand image containing the credit card logos. The value for this parameter is a hex-coded RGB color-value for the color you’re using as your background color, e.g. f0f0f0.

confirmUrl

With the parameter confirmUrl you can define the URL of your online shop used by the QENTA Checkout Server to send to your online shop some return values containing the result of the payment process.

Parameters

For QPAY Checkout Page confirmUrl is optional because the same parameters and values are posted to successUrl, failureUrl, cancelUrl or pendingUrl.

For QMORE Checkout Seamless confirmUrl is required because no return parameters are sent to the successUrl.

Use the confirmUrl to save the result of each payment process in your database for later use. Additionally, if your consumer does not receive the page of the successUrl, the confirmUrl allows you to get informed about the result of the payment process anyway.

The URL has to be accessible over the Internet via port 80 (HTTP) or port 443 (HTTPS) and may not be hosted on a local server that can’t be accessed by the QENTA Checkout Server via the Internet. Also, ensure that your firewall configurations allow receiving the confirmation sent via 212.183.46.16/28. For HTTPS communication only TLS can be used, older protocols are not supported.

Confirmation redelivery attempts

QENTA does not verify whether or not the confirmation was successfully received by your web server. Redelivery attempts can be enabled by our integration specialists, they will set the intervals for redelivery attempts according to your requirements. The intervals are set in minutes, minimum is one minute, or hours, maximum is 99 hours. During times of high load on the QENTA Checkout Server, a redelivery attempt may start a bit delayed, however, it will never start before your defined interval. To use this feature, the request parameter confirmUrl has to be sent. Optionally you may use the request parameter confirmMail to send confirmation emails individually per transaction.

If the confirmation was successfully received, the response will be OK; otherwise, the response will be NOK and a message which specifies the error. Use one of the following three possibilities to configure your response parameters.

The following content is possible for HTML comments and plain response: <QPAY-CONFIRMATION-RESPONSE result="OK|NOK" message="ans..255"/>

Examples

Embedded as HTML comment
<!--<QPAY-CONFIRMATION-RESPONSE result="OK" /> -→ (1)
<!--<QPAY-CONFIRMATION-RESPONSE result="NOK" message="Fingerprint validation failed."/> -→ (2)
1 for confirming the successful receipt of our confirmation.
2 for confirming the unsuccessful receipt of our confirmation.

Embedded as a plain response
<QPAY-CONFIRMATION-RESPONSE result="OK" /> (1)
<QPAY-CONFIRMATION-RESPONSE result="NOK" message="Session not found." /> (2)
1 for confirming the successful receipt of our confirmation.
2 for confirming the unsuccessful receipt of our confirmation.

As JSON response if header content type is application/JSON
{"status":"OK","errorCodes":null,"QPAY-CONFIRMATION-RESPONSE":{"result": "OK"}} (1)
{"status":"NOK","errorCodes":12345,"QPAY-CONFIRMATION-RESPONSE":{"result": "NOK","message":"Session not found."}} (2)
1 for confirming the successful receipt of our confirmation.
2 for confirming the unsuccessful receipt of our confirmation.
If your web server is down for some reason or can’t be accessed by the QENTA Checkout Server, the confirmUrl can’t be delivered and no responses may be sent. QENTA will continue to resend the confirmation until receiving the %%result="OK"%% or until the last redelivery attempt was made.

In case QENTA has sent a confirmation and no response was received by the time the last redelivery attempt was made, only one final information is sent to the given email address.

If the consumer in your online shop has terminated a session unexpectedly e.g. closing the browser window, the first confirmation is sent automatically and not earlier than 30 minutes after the request was sent by QENTA.

customerStatement

With the parameter customerStatement you can define a text which is displayed on the bank statement issued to your consumer by the financial service provider.

The appearance of this text and also the allowed set of characters and the length of the text depend on the financial service provider.

displayText

With the parameter displayText you can define a text which is displayed during the payment process on the QPAY Checkout Page. If displayText is not used, the required parameter OrderDescription will be used instead.

This text is not transmitted to any financial service provider and is therefore NEVER displayed on any consumer’s invoice or statement.

duplicateRequestCheck

With the parameter duplicateRequestCheck you can check if the same order has been unintentionally sent more than once by your consumer. Your consumer may unintentionally resend the same order by pressing the reload button of the browser because of problems with the internet connection.

For this check ensure that the required parameter orderDescription or any other customer parameter used in the fingerprint calculation is different for each order to prevent false-positive detection of duplicate requests. Since for each request, a hash of all parameter values is sent, i.e. the fingerprint, QENTA can easily detect any identical request that has been sent in the last 30 minutes.

If you want QENTA to check for duplicate requests, set the value of parameter to “yes”; otherwise, don’t send this parameter.

financialInstitution

You can use the parameter financialInstitution in conjunction with the parameter paymentType, when a specific payment method is selected by your consumer in your online shop. You can define one or more financial institutions which you want to offer to your consumer based on the selected payment method. The individual brands may be listed in any order within the parameter:

  • Allow all brands, force 3-D Secure for brands that support 3-D Secure: financialInstitution=amexsafekey,Diners,Discover,MCSC,Maestro,VbV

  • Limit to American Express SafeKey, Mastercard, and Visa 3-D Secure: financialInstitution=amexsafekey,MCSC,VbV

Payment method EPS only allow one value, while other payment methods like Credit Cards allow a comma-separated list of values.

Values of financialInstitution by paymentType

Table 3. paymentType AFTERPAY
Possible value(s) of financialInstitution Description

afterpay-inst

Installment for AfterPay

afterpay-inv

Invoice for AfterPay

Table 4. paymentType CCARD
Possible value(s) of financialInstitution Description

MCSC

Mastercard ID Check

MC

Mastercard

Maestro

Maestro SecureCode

Visa

Visa

VbV

Visa Secure

Amex

American Express

amexsafekey

American Express SafeKey

Diners

Diners Club

Discover

Discover

Table 5. paymentType EPS

Possible value(s) of financialInstitution

Description

EPS-SO

EPS SELECT OPTION

Table 6. paymentType INVOICE

Possible value(s) of financialInstitution

Description

payolution

Invoice by payolution

Table 7. paymentType PAYPAL
Possible value(s) of financialInstitution Description

PAYPAL

PayPal

Table 8. paymentType PRZELEWY24
Possible value(s) of financialInstitution Description

Przelewy24

Przelewy24

Table 9. paymentType SEPA-DD
Possible value(s) of financialInstitution Description

SEPA-DD

SEPA Direct Debit

Table 10. paymentType SOFORTUEBERWEISUNG
Possible value(s) of financialInstitution Description

SOFORTUEBERWEISUNG

Sofort.

imageUrl

With the parameter imageUrl you can define the URL to an image on your web server. Image will be displayed during the payment process on QPAY Checkout Page. Image size should have a width of 200 pixels and a height of 100 pixels and the supported image formats are gif, jpg, and png.

For security reasons we don’t accept .svg images provided by the customer, so use .png instead.

There must be an image available within the given image URL; , the loading of QPAY Checkout Page will be delayed until a time-out for the missing image occurs.

If you don’t use the imageUrl the required parameter serviceUrl will not be used; otherwise, the image will be encapsulated by a link to the serviceUrl, so that the consumer can click on the image to view the HTML page available at the serviceUrl.

This URL has to be accessible over the internet https:// and must be accessible by the QENTA Checkout Server.

noScriptInfoURL

With the parameter noScriptInfoURL define the URL to an information page of your online shop which is displayed to your consumer if the web browser of your consumer has JavaScript disabled.

On this information page within your online shop, you can inform your consumer of the requirement to enable JavaScript and a guide on how to do this in the web browser.

orderIdent

With the parameter orderIdent you can define a unique reference to a specific order of a specific consumer within your online shop. This parameter is used within the QENTA Data Storage together with the customerId, shopId and storageId that only you’re able to access the specific session of the QENTA Data Storage.

The value of the orderIdent has to be unique for each order of your consumer. You have to use the same value for initializing the QENTA Data Storage and for initiating the payment process.

orderReference

With the parameter orderReference you can define a unique transaction ID that will be forwarded to the financial institution.

The set of allowed characters and the allowed maximum length depends on the payment methods and the corresponding financial service providers.

pendingUrl

With the parameter pendingUrl you can define the URL of your online shop where your consumer is forwarded when the payment process could not determine a result yet.

When using the optional parameter pendingUrl, the use of the parameter confirmUrl is mandatory.

The pendingUrl is an optional request parameter for backward compatibility to existing online shops, but we strongly encourage you to use the parameter for handling asynchronous payment methods or payment methods which may have sometimes a delay in returning a final state of a transaction.

When the QENTA Checkout Server receives a final state from the corresponding financial service provider, we will send this information to the confirmUrl, so that you’re aware of the final state of the pending payment.

Table 11. pendingUrl in Payment Methods
paymentType Required Highly recommended Not needed

AFTERPAY

CCARD

CRYPTO

EPS

GIROPAY

INVOICE

PRZELEWY24

PAYPAL

PSC

SEPA-DD

SOFORTUEBERWEISUNG

purchaseInformation

If consumer has entered or changed his shipping or billing information after initialization, e.g. when using PayByLink then purchaseInformation is returned in confirmation request made to confirmUrl. It is a Base64 encoded string that contains consumer, basket and order data as well as any additional parameters sent during initialization in JSON.

Example
purchaseInformation=ewogICAgImFkZGl0aW9uYWxQYXJhbWV0ZXJzIjogewogICAgICAgICJDT05TVU1FUl9NRVJDSEFOVF9DUk1fSUQiOiAiMTIzNDIzNTM0NiIsCiAgICAgICAgInNob3BuYW1lX2N1c3RvbVBhcmFtZXRlcjEiOiAieW91ciBmaXJzdCBjdXN0b20gcGFyYW1ldGVyIiwKICAgICAgICAic2hvcG5hbWVfY3VzdG9tUGFyYW1ldGVyMiI6ICJ5b3VyIHNlY29uZCBjdXN0b20gcGFyYW1ldGVyIgogICAgfSwKICAgICJvcmRlckRlc2NyaXB0aW9uIjogIlRlc3Q6MDAwMCIsCiAgICAiY3VzdG9tZXJTdGF0ZW1lbnQiOiAiWW91ciBTaG9wbmFtZTogT3JkZXI6IDEyM3BhZ2UiLAogICAgIm9yZGVyUmVmZXJlbmNlIjogIjEyM3BhZ2UiLAogICAgImNvbnN1bWVyQmlsbGluZ0ZpcnN0TmFtZSI6ICJBbmRlcmVyQmlsbGluZyIsCiAgICAiY29uc3VtZXJCaWxsaW5nTGFzdE5hbWUiOiAiQmlsaW5nbmFjaG5hbWUiLAogICAgImNvbnN1bWVyQmlsbGluZ0FkZHJlc3MxIjogIkNcL08gS1x1MDBmY25pYmVydCBHcm9cdTAwZGYiLAogICAgImNvbnN1bWVyQmlsbGluZ0FkZHJlc3MyIjogIkJpbGxpbmdzdHJhXHUwMGRmZSAxMCIsCiAgICAiY29uc3VtZXJCaWxsaW5nQ2l0eSI6ICJHcmF6IiwKICAgICJjb25zdW1lckJpbGxpbmdaaXBDb2RlIjogIjgwMjAiLAogICAgImNvbnN1bWVyQmlsbGluZ0NvdW50cnkiOiAiU1IiLAogICAgImNvbnN1bWVyQmlsbGluZ1N0YXRlIjogIndvaXNkYXMiLAogICAgImNvbnN1bWVyU2hpcHBpbmdGaXJzdE5hbWUiOiAiU2hpcFZvcm5hbWVOZXUiLAogICAgImNvbnN1bWVyU2hpcHBpbmdMYXN0TmFtZSI6ICJTaGlwTmFjaG5hbWVOZXUiLAogICAgImNvbnN1bWVyU2hpcHBpbmdBZGRyZXNzMSI6ICJTaGlwcGluZ3N0cmFcdTAwZGZlIDEwYSIsCiAgICAiY29uc3VtZXJTaGlwcGluZ0FkZHJlc3MyIjogIjVcL0EgLSAzMyBTdC4gMTAwMCIsCiAgICAiY29uc3VtZXJTaGlwcGluZ0NpdHkiOiAiR3JheiIsCiAgICAiY29uc3VtZXJTaGlwcGluZ1ppcENvZGUiOiAiODAyMCIsCiAgICAiY29uc3VtZXJTaGlwcGluZ1N0YXRlIjogIkFuZHJlclN0YWF0IiwKICAgICJjb25zdW1lclNoaXBwaW5nQ291bnRyeSI6ICJHVSIsCiAgICAiY29uc3VtZXJTaGlwcGluZ0l0ZW1BdmFpbGFiaWxpdHkiOiAiMDEiLAogICAgImNvbnN1bWVyU2hpcHBpbmdNZXRob2QiOiAiaG9tZV9kZWxpdmVyeSIsCiAgICAiY29uc3VtZXJTaGlwcGluZ0FkZHJlc3NGaXJzdFVzZURhdGUiOiAiMTAuMTIuMjAyMSIsCiAgICAiYmFza2V0SXRlbXMiOiAiMyIsCiAgICAiYmFza2V0SXRlbSI6IHsKICAgICAgICAiMSI6IHsKICAgICAgICAgICAgImFydGljbGVOdW1iZXIiOiAiQTAwMSIsCiAgICAgICAgICAgICJxdWFudGl0eSI6ICIxIiwKICAgICAgICAgICAgIm5hbWUiOiAiUHJvZHVjdCBBMSIsCiAgICAgICAgICAgICJ1bml0R3Jvc3NBbW91bnQiOiAiMTAuODAiLAogICAgICAgICAgICAidW5pdE5ldEFtb3VudCI6ICI5LjAwIiwKICAgICAgICAgICAgInVuaXRUYXhBbW91bnQiOiAiMS44MCIsCiAgICAgICAgICAgICJ1bml0VGF4UmF0ZSI6ICIyMC4wMDAiCiAgICAgICAgfSwKICAgICAgICAiMiI6IHsKICAgICAgICAgICAgImFydGljbGVOdW1iZXIiOiAiQTAwMiIsCiAgICAgICAgICAgICJxdWFudGl0eSI6ICIxIiwKICAgICAgICAgICAgIm5hbWUiOiAiUHJvZHVjdCBBMiIsCiAgICAgICAgICAgICJ1bml0R3Jvc3NBbW91bnQiOiAiMTQuOTQiLAogICAgICAgICAgICAidW5pdE5ldEFtb3VudCI6ICIxMi40NSIsCiAgICAgICAgICAgICJ1bml0VGF4QW1vdW50IjogIjIuNDkiLAogICAgICAgICAgICAidW5pdFRheFJhdGUiOiAiMjAuMDAwIgogICAgICAgIH0sCiAgICAgICAgIjMiOiB7CiAgICAgICAgICAgICJhcnRpY2xlTnVtYmVyIjogIlMwMDEiLAogICAgICAgICAgICAicXVhbnRpdHkiOiAiMSIsCiAgICAgICAgICAgICJuYW1lIjogIlNoaXBwaW5nIiwKICAgICAgICAgICAgInVuaXRHcm9zc0Ftb3VudCI6ICI5NzQuMjUiLAogICAgICAgICAgICAidW5pdE5ldEFtb3VudCI6ICI5NzQuMjUiLAogICAgICAgICAgICAidW5pdFRheEFtb3VudCI6ICIwLjAwIiwKICAgICAgICAgICAgInVuaXRUYXhSYXRlIjogIjAuMDAwIgogICAgICAgIH0KICAgIH0sCiAgICAiY29uc3VtZXJFbWFpbCI6ICJlZGl0aWVydGUuZW1haWwuYWRyZXNzZUB0ZXN0LmNvbSIsCiAgICAiY29uc3VtZXJTaGlwcGluZ1Bob25lIjogIjEyMzQ1Njc4MzQ1NjciLAogICAgImNvbnN1bWVySXBBZGRyZXNzIjogIjE3Mi4yMC4wLjIwMyIsCiAgICAiY29uc3VtZXJCaXJ0aERhdGUiOiAiMjAwMS0wMy0wMSIKfQ==
Decoded
{
    "additionalParameters": {
        "CONSUMER_MERCHANT_CRM_ID": "1234235346",
        "shopname_customParameter1": "your first custom parameter",
        "shopname_customParameter2": "your second custom parameter"
    },
    "orderDescription": "Test:0000",
    "customerStatement": "Your Shopname: Order: 123page",
    "orderReference": "123page",
    "consumerBillingFirstName": "AndererBilling",
    "consumerBillingLastName": "Bilingnachname",
    "consumerBillingAddress1": "C\/O K\u00fcnibert Gro\u00df",
    "consumerBillingAddress2": "Billingstra\u00dfe 10",
    "consumerBillingCity": "Graz",
    "consumerBillingZipCode": "8020",
    "consumerBillingCountry": "SR",
    "consumerBillingState": "woisdas",
    "consumerShippingFirstName": "ShipVornameNeu",
    "consumerShippingLastName": "ShipNachnameNeu",
    "consumerShippingAddress1": "Shippingstra\u00dfe 10a",
    "consumerShippingAddress2": "5\/A - 33 St. 1000",
    "consumerShippingCity": "Graz",
    "consumerShippingZipCode": "8020",
    "consumerShippingState": "AndrerStaat",
    "consumerShippingCountry": "GU",
    "consumerShippingItemAvailability": "01",
    "consumerShippingMethod": "home_delivery",
    "consumerShippingAddressFirstUseDate": "10.12.2021",
    "basketItems": "3",
    "basketItem": {
        "1": {
            "articleNumber": "A001",
            "quantity": "1",
            "name": "Product A1",
            "unitGrossAmount": "10.80",
            "unitNetAmount": "9.00",
            "unitTaxAmount": "1.80",
            "unitTaxRate": "20.000"
        },
        "2": {
            "articleNumber": "A002",
            "quantity": "1",
            "name": "Product A2",
            "unitGrossAmount": "14.94",
            "unitNetAmount": "12.45",
            "unitTaxAmount": "2.49",
            "unitTaxRate": "20.000"
        },
        "3": {
            "articleNumber": "S001",
            "quantity": "1",
            "name": "Shipping",
            "unitGrossAmount": "974.25",
            "unitNetAmount": "974.25",
            "unitTaxAmount": "0.00",
            "unitTaxRate": "0.000"
        }
    },
    "consumerEmail": "editierte.email.adresse@test.com",
    "consumerShippingPhone": "1234567834567",
    "consumerIpAddress": "172.20.0.203",
    "consumerBirthDate": "2001-03-01"
}

storageId

The parameter storageId is the unique ID to the QENTA Data Storage of a specific consumer within a specific payment process. The storageId is valid for 30 minutes after the latest use of an initialization, store or read operation on that Data Storage.

storageId gets invalid after a successful initiation of the payment process.

transactionIdentifier

With the parameter transactionIdentifier you can define whether a transaction is a single transaction or an initial transaction followed by many subsequent ones. Value SINGLE is a standard singular transaction for which authorization is given once by the consumer to collect only one transaction and value INITIAL for the first transaction of a series of recurring payments.

If the parameter transactionIdentifier is used, the configuration setting is overwritten correspondingly, if is not used, the value set in the merchant configuration is used.

Currently the transactionIdentifier may be used for payment methods PayPal and SEPA Direct Debit and it’s required to distinguish between a single transaction or the first transaction with subsequent transaction based on the first one.

Backend operation recurPayment may only be carried out if the transactionIdentifier value INITAL is used. For using the value INITIAL for subsequent recurring transactions you need to obtain additional approval from your financial service provider e.g. for PayPal. After receiving approval contact our integration specialists to enable feature.

useIbanBic

For merchants who wish to carry out recurring transactions based on Sofort but may not derive any IBAN/BIC from the source order, because it was made too long ago in the past and therefore no IBAN/BIC data are retrievable.

If No is set by the merchant, conversion of account number and bank sorting code is carried out and a recurring payment based on SEPA Direct Debit is made, and If Yes is set IBAN/BIC is taken from the Sofort source order and a recurring transaction based on SEPA Direct Debit is made.

windowName

With the parameter windowName you can define the name of the pop-up window of iframe where QPAY Checkout Page or an additional payment window is opened.

windowName is required if you offer payment methods that are opening an additional pop-up window like eps-Überweisung or PayPal. It ensures a proper return to the checkout process after that payment method-specific pop-up window is closed.

The window name must contain uppercase and lowercase letters and underscores, and must not contain any whitespace character and foreign characters.

Opening QPAY Checkout Page or QMORE Checkout Seamless within a pop-up window may cause problems to your consumers if they have enabled a pop-up blocker within their browsers or it’s activated by default.

SEPA

mandateId

The parameter mandateId defines a two-party mandate between the merchant and the debtor and is required for SEPA Direct Debit payments. The mandate is an agreement giving the merchant permission to debit the consumer’s account for the sum that the two parties agreed upon. Every mandate has an ID provided by the merchant that has to be unique for the creditor.

mandateSignatureDate

The parameter mandateSignatureDate defines the date on which the above-mentioned mandate was signed by the consumer.

Feature-Specific Parameters

autoDeposit

With the parameter autoDeposit you can enable an automatic deposit and day-end closing of payments. After a consumer has completed a payment in your online shop, the payment is only approved and not yet deposited.

Not deposited (uncaptured) approvals will expire after 7-14 calendar days. The exact deadline depends on the regulations provided by each financial service provider. After exceeding the individual deadline these payments can no longer be submitted or received. Contact our sales team to activate this feature.

confirmMail

With the parameter confirmMail you can define one email address of the merchant for receiving payment details regarding the orders of your consumers in the online shop. This email may contain information about payment state, order number, payment method, payment amount and payment currency.

QENTA can activate one of the two options:

  • QENTA will send the confirmation to your confirmMail only if your confirmUrl is not available.

  • QENTA will always send the confirmation to your confirmMail in any case.

Contact sales team to activate the feature.

Table 12. Payment States of the Payment Process

SUCCESS

The payment has been successfully finished by the consumer.

CANCEL

The payment process has been canceled by the consumer and has not been successfully finished.

FAILURE

A problem occurred during the payment process and the payment has not been successfully finished.

PENDING

The payment is in progress. We can’t inform you about the success or failure of the payment.

maxRetries

With the parameter maxRetries you can define the maximum number of payment attempts regarding a unique order.

Table 13. Value of maxRetries parameter
Value Behaviour

<0

No restriction regarding the number of retries a consumer can do.

=0

No retry is possible for your consumer. If an error occurs the consumer will be redirected to the failureUrl.

>0

Maximum number of retries your consumer can do before redirecting to the failureUrl.

Contact our sales team to activate this feature.

orderNumber

With the parameter orderNumber you can define a unique ID for the order and if the value of the parameter is set it’s not possible that your consumer uses that order number a second time, even if your consumer could not successfully finalize the payment process. Therefore orderNumber can only be used if the parameter maxRetries is set to 0.

The feature has to be activated by our sales team, otherwise QENTA is generating the orderNumber.

paymenttypeSortOrder

With the parameter paymenttypeSortOrder you can define the sort order of all displayed payment methods and their corresponding sub-methods if paymentType is set to SELECT.

You can offer a county-specific sort order by your payment methods with this parameter.

You can set the sort order of your payment methods by using a comma-separated list as defined within the parameter paymentType. Also you can find all available sub-methods within the description of the parameter financialInstitution and add them to the list.

shopId

With the parameter shopId you can define the unique identifier for your online shop within your customerId. This is used if you have multiple online shops or one online shop with multiple configurations within one customerId.

The use of shopId has to clarify with the support, so contact integration specialists.

javascriptScriptVersion

javascriptScriptVersion defines the version of the used JavaScript for managing the JavaScript-based communication between your HTML page and the QENTA Data Storage. If the parameter is set to pci3, QENTA datastorage creates an iFrame which you can integrate into your homepage.

If the parameter is not set we will deliver javascript fields to your system.

Response Parameters

Response Parameters

instrumentCountry

The information on the consumer’s country can’t be derived from the delivery address, so they will be taken from the data returned to QENTA by the respective financial service provider. E.g. in the case of credit cards, the country of the credit card issuer is returned and used to determine the consumer’s country.

instrumentCountry can be used for the payment methods: Credit Card, PayPal, and Sofort.

creditorId

The parameter creditorId identifies a merchant and allows consumers to manage their mandates with merchants more easily.

dueDate

The parameter dueDate defines the day when payment is debited from the consumer’s bank account.

financialInstitution

Values of financialInstitution by paymentType

Table 14. paymentType AFTERPAY
Possible value(s) of financialInstitution Description

afterpay-inst

Installment for AfterPay

afterpay-inv

Invoice for AfterPay

Table 15. paymentType CCARD
Possible value(s) of financialInstitution Description

MC

Mastercard

Maestro

Maestro SecureCode

Visa

Visa

Amex

American Express

Diners

Diners Club

Table 16. paymentType EPS

Possible value(s) of financialInstitution

Description

EPS-SO

EPS SELECT OPTION

Table 17. paymentType INVOICE

Possible value(s) of financialInstitution

Description

payolution

Invoice by payolution

Table 18. paymentType PAYPAL
Possible value(s) of financialInstitution Description

PAYPAL

PayPal

Table 19. paymentType PRZELEWY24
Possible value(s) of financialInstitution Description

Przelewy24

Przelewy24

Table 20. paymentType SEPA-DD
Possible value(s) of financialInstitution Description

SEPA-DD

SEPA Direct Debit

Table 21. paymentType SOFORTUEBERWEISUNG
Possible value(s) of financialInstitution Description

SOFORTUEBERWEISUNG

Sofort.

Table 22. paymentType PAYSAFECARD
Possible value(s) of financialInstitution Description

PAYSAFECARD

PAYSAFECARD

instrumentCountry

The information on the consumer’s country can’t be derived from the delivery address, so they will be taken from the data returned to QENTA by the respective financial service provider. E.g. in the case of credit cards, the country of the credit card issuer is returned and used to determine the consumer’s country.

instrumentCountry can be used for the payment methods: Credit Card, PayPal, and Sofort.

responseFingerprint

To check the authenticity of the return values sent from the QENTA Checkout Server to your online shop, compare the responseFingerprint with an hash of the return values.

Create a string by concatenating all returned parameters based on the order in the return parameter responseFingerprintOrder. Then hash the string with an HMAC-SHA-512 algorithm using the secret as cryptographic key and compare the result with the value of the return parameter responseFingerprint. If both values are identical, the response is authentic, i.e. the confirmation was indeed sent by QENTA. If these values are not identical, recheck the calculation and consider that someone compromised the return values or has sent a possibly false confirmation for the payment. Therefore, don’t trust these return values and don’t assume that the payment was made even if it appears that way to you!

In order to ensure secure communication it’s essential that you never disclose or share your secret with persons who are not involved in developing the online shop. Also, never forward the secret via unsecured communication channels e.g. mail, e-mail, fax or instant messaging. When the secret is submitted by fax make sure that the contents of the fax is disclosed only to authorized persons!

If you suspect that your secret is known to unauthorized persons contact our integration specialists immediately to request a new secret!

responseFingerprintOrder

An ordered list of parameters used for calculating the fingerprint of the response.