Detailed Description of Parameters
Request Parameters
ACCEPT_HEADERS
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special, up to 4096 characters. |
HTTP header of the consumer’s browser. |
ACCEPT_HEADERS |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special, up to 4096 characters. |
Description |
HTTP header of the consumer’s browser. |
ACCOUNTID
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, up to 9 characters. |
Account-ID. |
ACCOUNTID |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, up to 9 characters. |
Description |
Account-ID. |
ACCOUNT_TYPE
Parameter | Data Type | Description |
---|---|---|
|
Alphabetic with special characters, exactly 6 characters, with the value |
Bank of the consumer (see table below). |
ACCOUNT_TYPE |
|
---|---|
Data |
Value |
Data type |
Alphabetic with special characters, exactly 6 characters, with the value |
Description |
Bank of the consumer (see table below). |
ACCOUNT_TYPE |
Description |
---|---|
|
Bank selection hosted by the eps scheme operator. |
ADMIN_PASSWORD
The ADMIN_PASSWORD
parameter is set by our onboarding. For testing, the value of ADMIN_PASSWORD
is 9p3a0m5f
.
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with 8 characters, but by specification, it can also be up to 128 characters. |
Key-password. |
ADMIN_PASSWORD |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with 8 characters, but by specification, it can also be up to 128 characters. |
Description |
Key-password. |
The ADMIN_PASSWORD parameter is mandatory depending on which command is used.
|
Command | ADMIN_PASSWORD |
---|---|
required |
|
not used |
|
required |
|
required |
|
not used |
|
not used |
|
not used |
|
required |
|
required |
|
required |
|
required |
|
required |
|
required |
|
not used |
AMOUNT
The AMOUNT
parameter defines the payment amount which is to be done by the consumer of the online shop. Only one dot .
or comma ,
are allowed values as a decimal separator.
Parameter | Data Type |
---|---|
|
Numeric with special characters(dot,comma), up to 20 characters. |
Thousand separators are not permitted. |
The maximum number of decimal places depends on the selected currency within the currency parameter. Here are some examples:
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). |
APPLICATIONTYPE
With the parameter APPLICATIONTYPE
define the type of application. For using this integration type, the parameter value has to be S
.
Parameter | Data Type |
---|---|
|
Alphabetic with 1 character. |
BATCHNUMBER
Parameter | Data Type | Description |
---|---|---|
|
Numeric, up to 9 digits. |
Daily closing number. |
BATCHNUMBER |
|
---|---|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Daily closing number. |
BANK_ACCOUNT_OWNER
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters, 1 to 255. |
Account holder. |
BANK_ACCOUNT_OWNER |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special characters, 1 to 255. |
Description |
Account holder. |
BANK_BIC
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
Alphanumeric, 8 to 11 characters. |
BIC of the bank.
|
BANK_BIC |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, 8 to 11 characters. |
Description |
BIC of the bank. |
BANK_ACCOUNT_IBAN
It identifies an individual account, at a specific financial institution, in a particular country and is used to process financial transactions between institutions in different countries
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, 16 to 34 characters. |
IBAN of the account. |
BANK_ACCOUNT_IBAN |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, 16 to 34 characters. |
Description |
IBAN of the account. |
CANCELURL
CANCELURL
has to contain the URL of the page where the consumer is forwarded when the payment process is canceled. The consumer should be informed about the cancelation of the payment process and offered possibilities to retry the payment attempt or get in contact with the merchant.
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters. |
URL to which server points in case the customer cancels the transaction. |
CANCELURL |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special characters. |
Description |
URL to which server points in case the customer cancels the transaction. |
CARDHOLDERNAME
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special, up to 80 characters. |
Cardholder name. |
CARDHOLDERNAME |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special, up to 80 characters. |
Description |
Cardholder name. |
CARDVERIFYCODE
Parameter | Data Type | Description |
---|---|---|
|
Numeric, up to 4 digits. |
Check the digits of the credit card. Common names are also |
CARDVERIFYCODE |
|
---|---|
Data |
Value |
Data type |
Numeric, up to 4 digits. |
Description |
Check the digits of the credit card. Common names are also |
COMMAND
With the parameter COMMAND
specifies the command that will be used, and it must be passed for each one. Depending on which command is used, the passed value for the command is different.
Parameter | Data Type |
---|---|
|
Alphabetic |
Value of parameter COMMAND |
---|
CONFIRMURL
URL used for VitalityCheck (checking merchant session and possible prevention of payment execution) and Confirmation forwarding.
Parameter | Data Type |
---|---|
|
Alphanumeric with special characters. |
CREATEBEGINTIME
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Creation start time. |
CREATEBEGINTIME |
|
---|---|
Data |
Value |
Data type |
Date/time. |
Description |
Creation start time. |
CREATEENDTIME
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Creation time end. |
CREATEENDTIME |
|
---|---|
Data |
Value |
Data type |
Date/time. |
Description |
Creation time end. |
CREDITOR_ID
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, with up to 35 characters. |
Unique ID of the merchant for the processing of SEPA direct debits (assigned by the respective national bank). |
CREDITOR_ID |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, with up to 35 characters. |
Description |
Unique ID of the merchant for the processing of SEPA direct debits (assigned by the respective national bank). |
CREDITNUMBER
CREDITNUMBER
is the number of the generated credit note, and we get them after finishing the REFUND. After the refund use this CREDITNUMBER
to cancel a credit note with REFUNDREVERSAL.
Parameter | Data Type | Description |
---|---|---|
|
Numeric, up to 9 digits. |
Credit note number. |
CREDITNUMBER |
|
---|---|
Data |
Value |
Data type |
Numeric, up to 9 digits. |
Description |
Credit note number. |
CURRENCY
The CURRENCY
parameter defines the currency used in the payment.
Parameter | Data Type |
---|---|
|
Alphabetic or numeric, fixed 3 characters. |
By default, only EUR is enabled as currency. If additional currencies are required contact our sales team. |
Alphabetic value | Numeric value | Currency |
---|---|---|
|
|
Swiss Franc |
|
|
Czech Koruna |
|
|
Euro |
|
|
Pound Sterling |
|
|
Hungarian Forint |
|
|
Polish Zloty |
|
|
US Dollar |
Not all available payment methods support all currencies. |
CONSUMER_PLAN_NUMBER
Parameter | Data Type | Description |
---|---|---|
|
Numeric, up to 1 digit. |
The number of customer installment plans. Depending on the value of the parameter |
CONSUMER_PLAN_NUMBER |
|
---|---|
Data |
Value |
Data type |
Numeric, up to 1 digit. |
Description |
The number of customer installment plans. Depending on the value of the parameter |
CUSTOMERSTATEMENT
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
Alphanumeric with special characters, up to 254 characters. |
With the parameter
|
CUSTOMERSTATEMENT |
|
---|---|
Data |
Value |
Data type |
Alphanumeric with special characters, up to 254 characters. |
Description |
With the parameter |
CONSUMER_MERCHANT_CRM_ID
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, up to 50 characters. |
The merchant CRM ID of the consumer. |
CONSUMER_MERCHANT_CRM_ID |
|
---|---|
Data |
Value |
Data type |
Alphanumeric, up to 50 characters. |
Description |
The merchant CRM ID of the consumer. |
DEPOSITAMOUNT
With the parameter DEPOSITAMOUNT
define the debit amount with the initiation of payment. This only can be used if the payment method has an approved state, and the payment then will immediately be deposited with the DEPOSITAMOUNT
.
The value of this amount must not be bigger than the AMOUNT
parameter. If this parameter is not set or 0
, no deposit will be made. Also can be used for a recurring payment, with the same values.
Parameter | Data Type |
---|---|
|
Numeric with special characters(dot, comma), up to 20 characters. |
DEPOSITFLAG
Only useful in combination with an DEPOSITAMOUNT
when initiating the payment.
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Boolean. |
|
No deposit will be carried out, except if it’s a MOTO transaction. |
|
A direct debit is carried out immediately. |
DEPOSITFLAG |
|
---|---|
Data |
Value |
Data type |
Boolean |
Description |
|
DUE_DATE
The parameter DUE_DATE
defines the day when payment is debited from the consumer’s bank account. The format has to be (DD.MM.YYYY
or D.M.YYYY
). It can be used for initialization and recurring SEPA payment.
Parameter | Data Type | Description |
---|---|---|
|
String, min 8 max 10 characters. |
Date of mandate signature. The format has to be ( |
DUE_DATE |
|
---|---|
Data |
Value |
Data type |
String, min 8 max 10 characters. |
Description |
Date of mandate signature. The format has to be ( |
EXPIRY
Parameter | Data Type | Description |
---|---|---|
|
Numeric with special characters, up to 7 characters. |
Expiry date ( |
EXPIRY |
|
---|---|
Data |
Value |
Data type |
Numeric with special characters, up to 7 characters. |
Description |
Expiry date ( |
FAILUREURL
The FAILUREURL
parameter defines the URL of the online shop where the consumer is forwarded when the payment process has failed for any reason. On this page, the possibility to retry the payment or get in contact with support team.
Parameter | Data Type |
---|---|
|
Alphabetic with special characters. |
FALLBACK
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Boolean. |
|
If the card is not registered for 3DS, no authorization attempt is made. |
|
If the card is not registered for 3DS, an authorization attempt is made. |
FALLBACK |
|
---|---|
Data |
Value |
Data type |
Boolean |
Description |
|
FOR
FOR
is used for query orders and defines returned response set with it.
If the value of parameter FOR isn’t sent, the value is set to ANYCOMMAND .
|
Query | Parameter | Value | Description |
---|---|---|---|
Query Orders |
|
|
Returns all orders in status approved. |
|
Returns all orders in status approved. |
||
|
Returns all orders in the status posted. |
||
|
Delivers all orders in status credited. |
||
|
Deliver all orders, no matter which status. |
||
|
Deliver all orders, no matter which status. |
||
Query Credits |
|
|
Returns all credit notes that can be canceled. |
|
Returns all credit notes that have already been settled. |
||
|
Returns all credit notes, regardless of their status. |
||
Query Batches |
|
|
Returns all batches in open status. |
|
Returns all batches, no matter which status. |
FOR |
|
---|---|
Data |
Value |
Query |
Query Orders |
Data type |
Alfabetic |
Description |
|
|
|
Data |
Value |
Query |
Query Credits |
Data type |
Alfabetic |
Description |
|
|
|
Data |
Value |
Query |
Query Batches |
Data type |
Alfabetic |
Description |
|
INITTYPE
The initiation type should be defined with the parameter INITTYPE
. This value is different depending on which payment type is used.
Parameter | Data Type |
---|---|
|
Enumeration. |
Value of parameter INITTYPE |
Payment method | Description |
---|---|---|
|
Credit card with a 3D-Secure check like Mastercard, VISA, American Express, Diners Club, and Discover. |
|
|
Credit card without 3-D Secure check American Express Diners Club, Discover, JCB, MasterCard, Switch/Solo, UATP, VISA. |
|
|
Circle K gift card |
|
|
CVS Pharmacy gift card |
|
|
Dollar General gift card |
|
|
Electronic direct debit |
|
|
Austrian standard for online bank transfers, also be used for GIROPAY |
|
|
Invoice: Payolution |
Purchase on invoice |
|
oBucks gift card |
|
|
Part of Paysafecard portfolio of cash-based payment methods. |
|
|
PayPal |
|
|
paysafecard |
|
|
Polish online bank transfer |
|
|
Riverty’s invoice. |
|
|
Riverty’s installment. |
|
|
Part of Paysafecard portfolio of cash-based payment methods. |
|
|
sofortüberweisung |
3DSECURE |
|
---|---|
Data |
Value |
Payment method |
|
Description |
Credit card with a 3D-Secure check like Mastercard, VISA, American Express, Diners Club, and Discover. |
|
|
Data |
Value |
Payment method |
|
Description |
Credit card with a 3D-Secure check like Mastercard, VISA, American Express, Diners Club, and Discover. |
|
|
Data |
Value |
Payment method |
|
Description |
Circle K gift card |
|
|
Data |
Value |
Payment method |
|
Description |
CVS Pharmacy gift card |
|
|
Data |
Value |
Payment method |
|
Description |
Dollar General gift card |
|
|
Data |
Value |
Payment method |
|
Description |
Electronic direct debit |
|
|
Data |
Value |
Payment method |
|
Description |
Austrian standard for online bank transfers, also be used for GIROPAY |
|
|
Data |
Value |
Payment method |
Invoice: Payolution |
Description |
Purchase on invoice |
|
|
Data |
Value |
Payment method |
|
Description |
oBucks gift card |
|
|
Data |
Value |
Payment method |
|
Description |
Part of Paysafecard portfolio of cash-based payment methods. |
|
|
Data |
Value |
Payment method |
|
Description |
PayPal |
|
|
Data |
Value |
Payment method |
|
Description |
PayPal |
|
|
Data |
Value |
Payment method |
|
Description |
Polish online bank transfer |
|
|
Data |
Value |
Payment method |
|
Description |
Riverty’s invoice. |
|
|
Data |
Value |
Payment method |
|
Description |
Riverty’s installment. |
|
|
Data |
Value |
Payment method |
|
Description |
Part of Paysafecard portfolio of cash-based payment methods. |
|
|
Data |
Value |
Payment method |
|
Description |
sofortüberweisung |
IP_ADDRESS
With IP_ADDRESS
define a valid IP address and use IPv4 or IPv6.
IPv4 uses 32 bits and IPv6 128 bits for the IP address.
IP addresses are written and displayed in notations, such as 192.0.2.1 in IPv4, and 2001:db8:0:1234:0:567:8:1 in IPv6.
Parameter | Data Type |
---|---|
|
Alphanumeric with special characters. |
IS_RECURRING_TRANSACTION
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Boolean. |
|
The transaction is a normal back-office payment. |
|
The transaction is a recurring credit card payment by the cardholder from the back office. |
IS_RECURRING_TRANSACTION |
|
---|---|
Data |
Value |
Data Type |
Boolean |
Description |
|
ISSUE_DATE
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters, fixed 6 characters. |
Card issue date ( |
ISSUE_DATE |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special characters, fixed 6 characters. |
Description |
Card issue date ( |
ISSUE_NUMBER
Parameter | Data Type | Description |
---|---|---|
|
Numeric, up to 4 digits. |
Card sequence number. |
ISSUE_NUMBER |
|
---|---|
Data |
Value |
Data Type |
Numeric, up to 4 digits. |
Description |
Card sequence number. |
ISO_TRANSACTION_TYPE
The value corresponds to the type of ISO transaction. The values are derived from the ISO 8583 standard.
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Enumeration. |
|
Purchase of goods/services. |
|
Acceptance check. |
||
|
Account financing. |
||
|
Quasi-cash transaction. |
||
|
Prepaid, activation and charging. |
ISO_TRANSACTION_TYPE |
|
---|---|
Data |
Value |
Data Type |
Enumeration |
Description |
|
LANGUAGE
The LANGUAGE
parameter defines the language used for all messages of the QPAY Checkout Page and QMORE Checkout Seamless that are displayed to the consumer of the online shop.
Parameter | Data Type |
---|---|
|
Alphabetic, fixed 2 characters. |
By default, only English and German are activated. If the selected language is not supported by the respective financial service provider, the financial service provider decides which language is displayed to the consumer. |
Value | Language |
---|---|
|
Arabian |
|
Bosnian |
|
Bulgarian |
|
Chinese |
|
Croatian |
|
Czech |
|
Danish |
|
Dutch |
|
English |
|
Estonian |
|
Finnish |
|
French |
|
German |
|
Greek |
|
Hebrew |
|
Hindi |
|
Hungarian |
|
Italian |
|
Japanese |
|
Korean |
|
Latvian |
|
Lithuanian |
|
Macedonian |
|
Norwegian |
|
Polish |
|
Portuguese |
|
Romanian |
|
Russian |
|
Serbian |
|
Slovakian |
|
Slovenian |
|
Spanish |
|
Swedish |
|
Turkish |
|
Ukrainian |
LOGPATH
Path to the log directory of QTILL. This directory must be inside the LOGROOT
.
Parameter | Data Type |
---|---|
|
Alphanumeric with special, up to 1024 characters. |
MANDATE_ID
The parameter MANDATE_ID
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.
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, up to 35. |
Unique mandate reference (if indicated, the date of the mandated signature must also be indicated). |
MANDATE_ID |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric, up to 35. |
Description |
Unique mandate reference (if indicated, the date of the mandated signature must also be indicated). |
MANDATE_SIGNATURE_DATE
The parameter MANDATE_SIGNATURE_DATE
defines the date on which the above-mentioned mandate was signed by the consumer.
Parameter | Data Type | Description |
---|---|---|
|
Date as |
Date of mandate signature ( |
MANDATE_SIGNATURE_DATE |
|
---|---|
Data |
Value |
Data Type |
Date as |
Description |
Date of mandate signature ( |
MAXAMOUNT
Parameter | Data Type | Description |
---|---|---|
|
Numeric with special characters(dot, comma), up to 20 characters. |
Maximum amount, where dot or comma are allowed as decimal separators. |
MAXAMOUNT |
|
---|---|
Data |
Value |
Data Type |
Numeric with special characters(dot, comma), up to 20 characters. |
Description |
Maximum amount, where dot or comma are allowed as decimal separators. |
MAXTIMEOPENED
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Creation time end. |
MAXTIMEOPENED |
|
---|---|
Data |
Value |
Data Type |
Date/time. |
Description |
Creation time end. |
MAXTIMECLOSED
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Time of the last change-end. |
MAXTIMECLOSED |
|
---|---|
Data |
Value |
Data Type |
Date/time. |
Description |
Time of the last change-end. |
MERCHANTKEY
MERCHANTKEY
is provided by QENTA Payment CEE, and it must be passed for each command. The merchant key for the test mode, that we can provide is 43gADp5.UOZxPTet6O8o8K6o-7RefQB3BO21OMu4chB65LJUI_
.
Parameter | Data Type |
---|---|
|
Alphanumeric with special characters, up to 50 characters. |
MERCHANTREFERENCE
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
ASCII up to 128 characters, but may differ for specific payment methods. |
Merchant reference for the booking to be forwarded to the financial service provider if supported by the payment system.
|
MERCHANTREFERENCE |
|
---|---|
Data |
Value |
Data Type |
ASCII up to 128 characters, but may differ for specific payment methods. |
Description |
Merchant reference for the booking to be forwarded to the financial service provider if supported by the payment system. |
MERCHANT_TOKENIZATION_FLAG
Only used for credit cards and the default value is FALSE
.
With the parameter, MERCHANT_TOKENIZATION_FLAG
set the recurring flaggings for specific orders. It has to be set to TRUE
to save the consumer’s card details for later use.
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Boolean. |
|
If the transaction will not be used for future referencing. |
|
If the transaction will be used for future referencing. |
MERCHANT_TOKENIZATION_FLAG |
|
---|---|
Data |
Value |
Data Type |
Boolean. |
Description |
|
If this parameter is set to TRUE , the CONSUMER_CHALLENGE_INDICATOR also has to be set to 04 .
|
MINAMOUNT
Parameter | Data Type | Description |
---|---|---|
|
Numeric with special characters(dot, comma), up to 20 characters. |
Minimum amount, where dot or comma are allowed as decimal separators. |
MINAMOUNT |
|
---|---|
Data |
Value |
Data Type |
Numeric with special characters(dot, comma), up to 20 characters. |
Description |
Minimum amount, where dot or comma are allowed as decimal separators. |
MINTIMEOPENED
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Creation start time. |
MINTIMEOPENED |
|
---|---|
Data |
Value |
Data Type |
Date/time. |
Description |
Creation start time. |
MINTIMECLOSED
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Time of the last change-start. |
MINTIMECLOSED |
|
---|---|
Data |
Value |
Data Type |
Date/time. |
Description |
Time of the last change-start. |
MODIFYBEGINTIME
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Time of the last change-start. |
MODIFYENDTIME
Parameter | Data Type | Description |
---|---|---|
|
Date/time. |
Time of the last change-end. |
MODIFYENDTIME |
|
---|---|
Data |
Value |
Data Type |
Date/time. |
Description |
Time of the last change-end. |
ORDERBY
ORDERBY
is used for query orders and specifying by which properties objects are sorted.
Query | Parameter | Value | Description |
---|---|---|---|
Query Orders |
|
|
Object properties are sorted by brand in ascending order. |
|
Object properties are sorted by currency in ascending order. |
||
|
Object properties are sorted by order number in ascending order. |
||
|
Object properties are sorted by batch number in ascending order. |
||
|
Object properties are sorted by payment type in ascending order. |
||
|
Object properties are sorted by time of last change in ascending order. |
||
|
Object properties are sorted by time of creation in ascending order. |
||
|
Object properties are sorted by order description in ascending order. |
||
|
Object properties are sorted by order reference in ascending order. |
||
|
Object properties are sorted by an amount in ascending order. |
||
Query Credits |
|
|
Object properties are sorted by order number in ascending order. |
|
Object properties are sorted by credit number in ascending order. |
||
|
Object properties are sorted by batch number in ascending order. |
||
|
Object properties are sorted by payment type in ascending order. |
||
|
Object properties are sorted by time of last change in ascending order. |
||
|
Object properties are sorted by time of creation in ascending order. |
||
|
Object properties are sorted by an amount in ascending order. |
||
Query Batches |
|
|
Object properties are sorted by batch number in ascending order. |
|
Object properties are sorted by payment type in ascending order. |
||
|
Object properties are sorted by time of execution in ascending order. |
||
|
Object properties are sorted by time of opening in ascending order. |
ORDERBY |
|
---|---|
Data |
Value |
Query |
Query Orders |
Data Type |
Alfabetic |
Description |
|
|
|
Data |
Value |
Query |
Query Credits |
Data Type |
Alfabetic |
Description |
|
|
|
Data |
Value |
Query |
Query Batches |
Data Type |
Alfabetic |
Description |
|
ORDERDESCRIPTION
The ORDERDESCRIPTION
parameter is a description of what the 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. The text is displayed in the QPC Payment Center.
Parameter | Data Type |
---|---|
|
Alphanumeric, up to 255. |
ORDERNUMBER
ORDERNUMBER
defines a unique ID for the order and when the value of the parameter is set it’s not possible to use that order number for the second time. Even if the consumer could not successfully finalize the payment process.
Parameter | Data Type |
---|---|
|
Numeric, up to 9 digits. |
The feature has to be activated by our sales team, otherwise QENTA is generating the ORDERNUMBER .
|
ORDERREFERENCE
The ORDERREFERENCE
parameter defines a unique transaction ID that will be forwarded to the financial institution.
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
Alphanumeric with special characters, up to 128 characters. |
Order Reference - With the parameter
|
ORDERREFERENCE |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special characters, up to 128 characters. |
Description |
Order Reference - With the parameter |
ORDERTEXT
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters, up to 255 characters. |
Order description. |
ORDERTEXT |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special characters, up to 255 characters. |
Description |
Order description. |
ORIGINATOR
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with 50 characters. |
The user (or the system), who (or which) called this command. |
ORIGINATOR |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with 50 characters. |
Description |
The user (or the system), who (or which) called this command. |
OVERWRITE_WAKEUPMESSAGE
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Boolean. |
|
Wakeupmessage contains a reference to about:blank, which may lead to a security warning in the browser. |
|
The reference to about:blank in the wakeupmessage is replaced with the relative reference to 3dsblank.html. This page must then be available in the script context. |
OVERWRITE_WAKEUPMESSAGE |
|
---|---|
Data |
Value |
Data Type |
Boolean |
Description |
|
PAN
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
Numeric, up to 19 digits. |
Credit card number.
|
PAN |
|
---|---|
Data |
Value |
Data Type |
Numeric, up to 19 digits. |
Description |
Credit card number. |
PAYMENTNUMBER
The value of the parameter PAYMENTNUMBER
is identical to the ORDERNUMBER
.
Parameter | Data Type |
---|---|
|
Numeric, up to 9 digits. |
PAYMENTTYPE
The PAYMENTTYPE
parameter is the name of the payment method the user selected in the online shop.
Parameter | Data Type |
---|---|
|
Enumeration. |
This parameter is mandatory for all payment methods, but for some of them, QTILL will automatically choose the value. See the table below to check that! |
Value of parameter PAYMENTTYPE |
Payment method | Mandatory parameter |
---|---|---|
|
Credit Card, Maestro SecureCode |
no |
no |
||
|
no |
|
|
yes |
|
yes |
||
yes |
||
yes |
||
yes |
||
yes |
||
yes |
||
|
yes |
|
|
Invoice: Payolution |
no |
|
no |
|
|
yes |
|
yes |
||
|
yes |
|
|
yes |
|
|
no |
To use a payment method, it must be purchased by the merchant and enabled by QENTA. If additional payment methods are required, contact our sales team. |
PERIODIC_TYPE
With the parameter PERIODIC_TYPE
set the periodic type of initial and recurring payments.
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Enumeration. |
|
When the cardholder initiates the transaction. |
|
When the merchant initiates the transaction. For unscheduled recurring payments with different amounts. |
||
|
For recurring payments like subscriptions with the same interval and same amount. |
PERIODIC_TYPE |
|
---|---|
Data |
Value |
Data Type |
Enumeration. |
Description |
|
REFERENCENUMBER
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters, up to 128 characters. |
Financial service provider reference number (= approval code). |
REFERENCENUMBER |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special characters, up to 128 characters. |
Description |
Financial service provider reference number (= approval code). |
RETURNATMOST
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
Numeric, up to 9 characters. |
Number of objects that will be returned.
|
RETURNATMOST |
|
---|---|
Data |
Value |
Data Type |
Numeric, up to 9 characters. |
Description |
Number of objects that will be returned. |
SERVICEURL
The SERVICEURL
parameter is used to define the URL of a web page in an online shop which informs the consumer about the different possibilities to get in contact with the merchant.
Don’t use this URL to link to the shopping basket of the consumer! |
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.
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters. |
URL to which the issuer’s access control server branches if the transaction has been completed. This is integrated into the "Wake Up Message" by the payment server. |
SERVICEURL |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special characters. |
Description |
URL to which the issuer’s access control server branches if the transaction has been completed. This is integrated into the "Wake Up Message" by the payment server. |
SKIPFIRST
Parameter | Data Type | Description | ||
---|---|---|---|---|
|
Numeric, up to 9 characters. |
Start of the result.
|
SKIPFIRST |
|
---|---|
Data |
Value |
Data Type |
Numeric, up to 9 characters. |
Description |
Start of the result. |
SOURCEORDERNUMBER
Parameter | Data Type | Description |
---|---|---|
|
Numeric, up to 9 digits. |
Original order number for which a new payment is to be made. |
SOURCEORDERNUMBER |
|
---|---|
Data |
Value |
Data Type |
Numeric, up to 9 digits. |
Description |
Original order number for which a new payment is to be made. |
STATE
Parameter | Data Type | State of the stack | Description |
---|---|---|---|
|
Date/time. |
|
for open stacks. |
|
for closed stacks. |
STATE |
|
---|---|
Data |
Value |
Data Type |
Date/time. |
Description |
|
SUCCESSURL
The SUCCESSURL
parameter defines the URL of the online shop where the consumer is forwarded when the payment process has been completed.
Parameter | Data Type |
---|---|
|
Alphabetic with special characters. |
TRANSACTION_IDENTIFIER
With the parameter TRANSACTION_IDENTIFIER
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 TRANSACTION_IDENTIFIER is used, the configuration setting is overwritten correspondingly, it’s not used, and the value set in the merchant configuration is used.
|
Currently, the TRANSACTION_IDENTIFIER
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 TRANSACTION_IDENTIFIER value INITAL is used. For using the value INITIAL for subsequent recurring transactions, additional approval from the financial service provider needs to be obtained e.g. for PayPal. After receiving approval contact our integration specialists to enable the feature.
|
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Enumeration. |
|
For a one-time payment. |
|
For initial transactions in a subscription model. |
||
|
For subsequent transactions in a subscription model (requires the mandate reference to be specified). |
TRANSACTION_IDENTIFIER |
|
---|---|
Data |
Value |
Data Type |
Enumeration |
Description |
|
TRANSACTION_TYPE
Parameter | Data Type | Description |
---|---|---|
|
Enumeration. |
Overwrites transaction type used when processing the order for a refund. |
TRANSACTION_TYPE |
|
---|---|
Data |
Value |
Data Type |
Enumeration |
Description |
Overwrites transaction type used when processing the order for a refund. |
USER_AGENT
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special, up to 1024 characters. |
Identifier of the consumer’s browser (e.g. IE 11). |
USER_AGENT |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special, up to 1024 characters. |
Description |
Identifier of the consumer’s browser (e.g. IE 11). |
WAKEUPMESSAGE_METHOD
Depending on which WAKEUPMESSAGE_METHOD
is used, Wakeupmessage is displayed differently.
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Enumeration. |
|
Wakupmessage consists of an IFrame in which the ACS or CVC page is opened. |
|
Wakupmessage contains a simple form redirect to the ACS or CVC page. |
||
|
Wakeupmessage opens a new window. |
||
|
Wakeupmessage consists of an IFrame with an activated scrollbar in which the ACS or CVC page is opened. |
WAKEUPMESSAGE_METHOD |
|
---|---|
Data |
Value |
Data Type |
Enumeration |
Description |
|
WINDOWNAME
The WINDOWNAME
parameter defines the name of the pop-up window of iframe where QPAY Checkout Page or an additional payment window is opened.
Parameter | Data Type |
---|---|
|
Alphabetic. |
WINDOWNAME is required if the merchant offered payment methods that open 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 characters or foreign characters.
Opening within a pop-up window may cause problems to the consumers if they have enabled a pop-up blocker within their browsers or if it’s activated by default.
Response Parameters
batches
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric, with special characters. |
Number of daily closings included in this answer set. |
batches |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric, with special characters. |
Description |
Number of daily closings included in this answer set. |
body
Parameter | Description | ||
---|---|---|---|
|
HTTP body of the Wake-Up Message.
|
body |
|
---|---|
Data |
Value |
Description |
HTTP body of the Wake-Up Message. |
creditNumber
Parameter | Data Type | Description |
---|---|---|
|
Numeric |
Number of the credit note for this order. |
creditNumber |
|
---|---|
Data |
Value |
Data Type |
Numeric |
Description |
Number of the credit note for this order. |
credits
Parameter | Data Type | Description |
---|---|---|
|
Numeric |
Number of credits included in this response set. |
credits |
|
---|---|
Data |
Value |
Data Type |
Numeric |
Description |
Number of credits included in this response set. |
errorCode
With errorCode
get a numeric error code, which indicates on specific error that occurred.
Parameter | Data Type | Description |
---|---|---|
|
Numeric, fixed 5. |
Numeric error code |
Here are all errors that can get in response and their description. |
errorCode |
|
---|---|
Data |
Value |
Data Type |
Numeric, fixed 5. |
Description |
Numeric error code |
header
Parameter | Description | ||
---|---|---|---|
|
HTTP header of the Wake-Up Message.
|
header |
|
---|---|
Data |
Value |
Description |
HTTP header of the Wake-Up Message. |
message
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters. |
Error message. |
message |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special characters. |
Description |
Error message. |
objectsTotal
Parameter | Data Type | Description |
---|---|---|
|
Numeric. |
Total number of orders that match the search criteria. May be higher than the number of orders returned. |
objectsTotal |
|
---|---|
Data |
Value |
Data Type |
Numeric |
Description |
Total number of orders that match the search criteria. May be higher than the number of orders returned. |
orders
Parameter | Data Type | Description |
---|---|---|
|
Numeric |
Always |
orders |
|
---|---|
Data |
Value |
Data Type |
Numeric |
Description |
Always |
originator
The user (or the system), who (or which) called this command. originator
can be used to identify a system or user that performed a command. e.g. if someone logs in to the payment center, his username will be written in the database. It’s for internal use only.
Parameter | Data Type |
---|---|
|
Alphanumeric with 50 characters. |
paySysMessage
Parameter | Data Type | Description |
---|---|---|
|
Alphanumeric with special characters. |
Payment system-specific error message as a string. |
paySysMessage |
|
---|---|
Data |
Value |
Data Type |
Alphanumeric with special characters. |
Description |
Payment system-specific error message as a string. |
status
Every response has a version
parameter, and its value specified response status.
Parameter | Data Type | Value | Description |
---|---|---|---|
|
Numeric, fixed length of 1. |
|
Command was executed successfully. |
|
Error during parameter check. |
||
|
Rejection of the transaction. |
||
|
Error message from payment server/financial service provider. |
||
|
Internal/expected error. |
status |
|
---|---|
Data |
Value |
Data Type |
Numeric, fixed length of 1. |
Description |
|