Response Parameters
Response Parameters
General information
This page describes the response parameters returned from the QENTA Checkout Server to your online shop.
Take the following information into consideration during integration into your online shop:
-
Use the same upper- and lowercase writing of the parameter names and values as described.
-
Check all responses of the QENTA Checkout Server by using the fingerprint method as described in the sections describing the handling of the response parameters.
-
Some payment methods return additional response parameters or may have other particular requirements regarding response parameters. Therefore the number of response parameters is not fixed. Have a look at the Payment method specific documentation for more information about the use of these additional response parameters and particular parameters.
| The number of response parameters is not fixed, but depends on the payment method. |
State parameters
| Parameter | Data type | Short description |
|---|---|---|
paymentState |
Enumeration |
Result of payment process: "SUCCESS", "CANCEL", "FAILURE" or "PENDING". |
For successful or pending payments
| Parameter | Data type | Short description |
|---|---|---|
Enumeration |
Based on pre-selected payment method a sub-selection of financial institutions regarding to pre-selected payment method. |
|
Alphabetic with a fixed length of 2. |
Language used for displayed texts on payment page. |
|
orderNumber |
Numeric value with a variable length of up to 9 digits. |
Unique number identifying the payment. |
Enumeration |
Selected payment method of your consumer. |
|
responseFingerprint |
Alphanumeric with a fixed length of 128. |
Returned fingerprint of the parameter values as given in the requestFingerprintOrder. |
responseFingerprintOrder |
Alphanumeric with special characters. |
Ordered list of parameters used for calculating the fingerprint. |
Additionally for successful payments
| Parameter | Data type | Short description |
|---|---|---|
amount |
Amount |
Amount of payment. |
currency |
Alphabetic with a fixed length of 3. |
Currency code of amount. |
gatewayContractNumber |
Alphanumeric with special characters with a variable length of up to 255 characters. |
Contract number of the processor or acquirer. |
gatewayReferenceNumber |
Alphanumeric with special characters with a variable length of up to 255 characters. |
Technical reference number of the processor. |
providerReferenceNumber |
Alphanumeric with special characters with a variable length of up to 255 characters. |
Technical reference number of the financial service provider or acquirer. [1] |
For failed payments
QPAY Checkout Page
| Parameter | Data type | Short description |
|---|---|---|
message |
Alphanumeric with special characters. |
Error text describing the failure. |
QMORE Checkout Seamless
| Parameter | Data type | Short description |
|---|---|---|
errors |
Numeric |
Number of errors occurred. |
error.{n}.errorCode |
Numeric with a fixed length of 5. |
Numeric error code which you should log for later use. |
error.{n}.message |
Alphanumeric with special characters. |
Error message in English. |
error.{n}.consumerMessage |
Alphanumeric with special characters. |
Error message in localized language for your consumer. |
error.{n}.paySysMessage |
Alphanumeric with special characters. |
Payment method system specific error message only relevant for merchant. |
Payment method specific parameters
For some payment methods you will get specific response parameters which are only sent if those payment methods are enabled for your online shop and used by your consumers. Please have a look at the payment specific documentation regarding these parameters and their meaning at Integration of specific payment methods.
Feature-specific parameters
These response parameters enhance the result data of the payment process regarding specific features and functions and are enabled by QENTA on your behalf.
To enable one or more of these response parameters contact our support teams.
| Parameter | State | Data type | Short description |
|---|---|---|---|
liabilityShiftIndicator |
Success |
Alphabetic with a fixed length of 1 and possible value of "Y" or "N". |
Only available and returns "Y" if it indicates liability shift, otherwise this parameter is not returned or returns "N". Please be aware that exception exists for corporate cards and interregional transactions. |
Success |
Alphabetic with a fixed length of 2. |
Country of the consumer which has been detected and returned by the financial service provider. Please be aware that this feature is not provided by all financial service providers. |
The parameter instrumentCountry is also returned via the transaction-based operation (back-end operation) getOrderDetails both for QPAY Checkout Page and QMORE Checkout Seamless.
Detailed description of parameters
financialInstitution
Value of parameterpaymentType |
Possible value(s) of parameterfinancialInstitution |
Description |
|---|---|---|
CCARD / CCARD-MOTO / MASTERPASS |
MC |
Mastercard |
::: |
MC |
Mastercard ID Check |
::: |
MAESTRO |
Maestro SecureCode |
::: |
Visa |
Visa |
::: |
Visa |
Visa Secure |
::: |
Amex |
American Express |
::: |
Amex |
American Express SafeKey |
::: |
Diners |
Diners Club |
::: |
Discover |
Discover |
CCARD / CCARD-MOTO |
EPS |
|
ARZ |
AAB |
Austrian Anadi Bank AG |
::: |
ARZ |
BAF |
Österreichische Ärzte- und Apothekerbank |
::: |
ARZ |
MB |
Marchfelder Bank |
::: |
BA-CA |
Bank Austria |
::: |
ARZ |
BCS |
Bankhaus Carl Spängler & Co. AG |
::: |
ARZ |
BSS |
Bankhaus Schelhammer & Schattera AG |
::: |
Bawag |
BG |
BAWAG P.S.K. AG |
::: |
ARZ |
BKS |
BKS Bank AG |
::: |
ARZ |
BKB |
Brüll Kallmus Bank AG |
::: |
ARZ |
BTV |
BTV VIER LÄNDER BANK |
::: |
ARZ |
CBGG |
Capital Bank Grawe Gruppe AG |
::: |
ARZ |
DB |
Dolomitenbank |
::: |
Bawag |
EB |
Easybank AG |
::: |
Spardat |
EBS |
Erste Bank und Sparkassen |
::: |
ARZ |
HAA |
Hypo Alpe-Adria-Bank International AG |
::: |
ARZ |
VLH |
Hypo Vorarlberg Bank AG |
::: |
ARZ |
NLH |
HYPO NOE LB für Niederösterreich u. Wien |
::: |
Hypo-Racon |
O |
Hypo Oberösterreich |
::: |
Hypo-Racon |
S |
Hypo Salzburg |
::: |
Hypo-Racon |
St |
Hypo Steiermark |
::: |
ARZ |
HTB |
Hypo Tirol Bank AG |
::: |
BB-Racon |
Bank Burgenland |
::: |
ARZ |
OB |
Oberbank AG |
::: |
Racon |
Raiffeisen Bankengruppe Österreich |
::: |
ARZ |
SB |
Schoellerbank AG |
::: |
Bawag |
SBW |
Sparda Bank Wien |
::: |
ARZ |
VB |
Volksbank Gruppe |
::: |
ARZ |
VKB |
Volkskreditbank AG |
::: |
ARZ |
VRB |
VR-Bank Braunau |
GIROPAY |
GIROPAY |
giropay |
IDL |
ABNAMROBANK |
ABN AMRO Bank |
::: |
ASNBANK |
ASN Bank |
::: |
BUNQ |
Bunq Bank |
::: |
INGBANK |
ING |
::: |
KNAB |
Knab |
::: |
RABOBANK |
Rabobank |
::: |
SNSBANK |
SNS Bank |
::: |
REGIOBANK |
Regio Bank |
::: |
TRIODOSBANK |
Triodos Bank |
::: |
VANLANSCHOT |
Van Lanschot Bankiers |
INVOICE |
payolution |
payolution |
INSTALLMENT |
payolution |
payolution |
PAYPAL |
PAYPAL |
PayPal |
PRZELEWY24 |
Przelewy24 |
Przelewy24 |
SEPA-DD |
SEPA-DD |
SEPA Direct Debit |
SOFORTUEBERWEISUNG |
SOFORTUEBERWEISUNG |
instrumentCountry
From January 1, 2015 a new rule applies on the sale of digital goods (exclusively digital goods) to consumers in EU countries. According to this rule the merchant is responsible for accounting for VAT to the respective authority of the consumer’s EU member state. Since in the case of digital goods the information on the consumer’s country cannot be derived from the delivery address, information on the consumer’s country is 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.
Currently, this parameter may be used for the following payment methods: Credit Card, iDEAL, PayPal and Sofort.