Detailed Description of Parameters

Request Parameters

ACCEPT_HEADERS

Parameter Data Type Description

Parameter	Data Type	Description
`ACCEPT_HEADERS`	Alphanumeric with special, up to 4096 characters.	HTTP header of the consumer’s browser.

ACCEPT_HEADERS

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

Parameter	Data Type	Description
`ACCOUNTID`	Alphanumeric, up to 9 characters.	Account-ID.

ACCOUNTID

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

Parameter	Data Type	Description
`ACCOUNT_TYPE`	Alphabetic with special characters, exactly 6 characters, with the value `EPS-SO`.	Bank of the consumer (see table below).

ACCOUNT_TYPE

Alphabetic with special characters, exactly 6 characters, with the value EPS-SO.

Bank of the consumer (see table below).

ACCOUNT_TYPE

Data

Value

Data type

Alphabetic with special characters, exactly 6 characters, with the value EPS-SO.

Description

Bank of the consumer (see table below).

Table 1. Valid Values for the ACCOUNT_TYPE Parameter
`ACCOUNT_TYPE`	Description
`EPS-SO`	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

Parameter	Data Type	Description
`ADMIN_PASSWORD`	Alphanumeric with 8 characters, but by specification, it can also be up to 128 characters.	Key-password.

ADMIN_PASSWORD

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

Command	`ADMIN_PASSWORD`
`APPROVEREVERSAL`	required
`DEPOSIT`	not used
`DEPOSITREVERSAL`	required
`GETORDERDETAILS`	required
`GETINSTALLMENTPLANS`	not used
`INITIATEPAYMENT`	not used
`PING`	not used
`QUERYBATCHES`	required
`QUERYCREDITS`	required
`QUERYORDERS`	required
`RECURPAYMENT`	required
`REFUND`	required
`REFUNDREVERSAL`	required
`VERIFYPAYMENT`	not used

APPROVEREVERSAL

required

DEPOSIT

not used

DEPOSITREVERSAL

required

GETORDERDETAILS

required

GETINSTALLMENTPLANS

not used

INITIATEPAYMENT

not used

PING

not used

required

required

required

required

REFUND

required

REFUNDREVERSAL

required

VERIFYPAYMENT

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.

Table 2. Data Type
Parameter	Data Type
`AMOUNT`	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).

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.

Table 3. Data Type
Parameter	Data Type
`APPLICATIONTYPE`	Alphabetic with 1 character.

BATCHNUMBER

Parameter Data Type Description

Parameter	Data Type	Description
`BATCHNUMBER`	Numeric, up to 9 digits.	Daily closing number.

BATCHNUMBER

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

Parameter	Data Type	Description
`BANK_ACCOUNT_OWNER`	Alphanumeric with special characters, 1 to 255.	Account holder.

BANK_ACCOUNT_OWNER

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

BANK_BIC

Alphanumeric, 8 to 11 characters.

BIC of the bank.

Depending on the respective SEPA acquirer or configured processing system, the parameter is mandatory or not.

BANK_BIC

Data

Value

Data type

Alphanumeric, 8 to 11 characters.

Description

BIC of the bank.
Depending on the respective SEPA acquirer or configured processing system, the parameter is mandatory or not.

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

Parameter	Data Type	Description
`BANK_ACCOUNT_IBAN`	Alphanumeric, 16 to 34 characters.	IBAN of the account.

BANK_ACCOUNT_IBAN

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.

BRAND

Parameter Data Type Description

Parameter	Data Type	Description
`BRAND`	Enumeration.	Brand.

BRAND

Enumeration.

Brand.

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

Parameter	Data Type	Description
`CANCELURL`	Alphanumeric with special characters.	URL to which server points in case the customer cancels the transaction.

CANCELURL

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

Parameter	Data Type	Description
`CARDHOLDERNAME`	Alphanumeric with special, up to 80 characters.	Cardholder name.

CARDHOLDERNAME

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

Parameter	Data Type	Description
`CARDVERIFYCODE`	Numeric, up to 4 digits.	Check the digits of the credit card. Common names are also `CVC2`, `CVV`, and `CID`.

CARDVERIFYCODE

Numeric, up to 4 digits.

Check the digits of the credit card. Common names are also CVC2, CVV, and CID.

CARDVERIFYCODE

Data

Value

Data type

Numeric, up to 4 digits.

Description

Check the digits of the credit card. Common names are also CVC2, CVV, and CID.

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.

Table 4. Data Type
Parameter	Data Type
`COMMAND`	Alphabetic

Table 5. Parameters for Specific Command
Value of parameter `COMMAND`
`APPROVEREVERSAL`
`CREATEORDER`
`DEPOSIT`
`DEPOSITREVERSAL`
`GETORDERDETAILS`
`GETINSTALLMENTPLANS`
`INITIATEPAYMENT`
`PING`
`QUERYBATCHES`
`QUERYCREDITS`
`QUERYORDERS`
`RECURPAYMENT`
`REFUND`
`REFUNDREVERSAL`
`VERIFYPAYMENT`

CONFIRMURL

URL used for VitalityCheck (checking merchant session and possible prevention of payment execution) and Confirmation forwarding.

Table 6. Data Type
Parameter	Data Type
`CONFIRMURL`	Alphanumeric with special characters.

CREATEBEGINTIME

Parameter Data Type Description

Parameter	Data Type	Description
`CREATEBEGINTIME`	Date/time.	Creation start time. Format: `DD.MM.YYY` `hh:mm:ss`

CREATEBEGINTIME

Date/time.

Creation start time.
Format: DD.MM.YYY hh:mm:ss

CREATEBEGINTIME

Data

Value

Data type

Date/time.

Description

Creation start time.
Format: DD.MM.YYY hh:mm:ss

CREATEENDTIME

Parameter Data Type Description

Parameter	Data Type	Description
`CREATEENDTIME`	Date/time.	Creation time end. Format: `DD.MM.YYY` `hh:mm:ss`

CREATEENDTIME

Date/time.

Creation time end.
Format: DD.MM.YYY hh:mm:ss

CREATEENDTIME

Data

Value

Data type

Date/time.

Description

Creation time end.
Format: DD.MM.YYY hh:mm:ss

CREDITOR_ID

Parameter Data Type Description

Parameter	Data Type	Description
`CREDITOR_ID`	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

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.

Table 7. Data Type
Parameter	Data Type	Description
`CREDITNUMBER`	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.

Table 8. Data Type
Parameter	Data Type
`CURRENCY`	Alphabetic or numeric, fixed 3 characters.

By default, only EUR is enabled as currency. If additional currencies are required contact our sales team.

Table 9. 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.

CONSUMER_PLAN_NUMBER

Table 10. Data Type
Parameter	Data Type	Description
`CONSUMER_PLAN_NUMBER`	Numeric, up to 1 digit.	The number of customer installment plans. Depending on the value of the parameter `AMOUNT`, his value is in the range of `1` to `5`.

Table 11. Data Type
`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 `AMOUNT`, his value is in the range of `1` to `5`.

CUSTOMERSTATEMENT

Parameter Data Type Description

CUSTOMERSTATEMENT

Alphanumeric with special characters, up to 254 characters.

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

In the table below are restrictions for the parameter CUSTOMERSTATEMENT for different payment methods.

Table 13. Data Type
`CUSTOMERSTATEMENT`
Data	Value
Data type	Alphanumeric with special characters, up to 254 characters.
Description	With the parameter `CUSTOMERSTATEMENT` define a text which is displayed on the bank statement issued to the consumer by the financial service provider. In the table below are restrictions for the parameter `CUSTOMERSTATEMENT` for different payment methods.

Table 14. Restrictions of Parameter `CUSTOMERSTATEMENT`
Acquirer	Brand	Data type
Riverty	Riverty	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	`CUSTOMERSTATEMENT` is not used and the name of the merchant is always displayed on the consumer’s bank statement.
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	Invoice	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

CONSUMER_MERCHANT_CRM_ID

Parameter Data Type Description

CONSUMER_MERCHANT_CRM_ID

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.

Table 15. Data Type
Parameter	Data Type
`DEPOSITAMOUNT`	Numeric with special characters(dot, comma), up to 20 characters.

DEPOSITFLAG

Only useful in combination with an DEPOSITAMOUNT when initiating the payment.

Table 16. Data Type
Parameter	Data Type	Value	Description
`DEPOSITFLAG`	Boolean.	`FALSE`	No deposit will be carried out, except if it’s a MOTO transaction.
`DEPOSITFLAG`	Boolean.	`TRUE`	A direct debit is carried out immediately.

DEPOSITFLAG

Data

Value

Data type

Boolean

Description

FALSE - No deposit will be carried out, except if it’s a MOTO transaction.
TRUE - A direct debit is carried out immediately.

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.

Table 17. Data Type
Parameter	Data Type	Description
`DUE_DATE`	String, min 8 max 10 characters.	Date of mandate signature. The format has to be (`DD.MM.YYYY` or `D.M.YYYY`).

DUE_DATE

Data

Value

Data type

String, min 8 max 10 characters.

Description

Date of mandate signature. The format has to be (DD.MM.YYYY or D.M.YYYY).

EXPIRY

Parameter Data Type Description

EXPIRY

Numeric with special characters, up to 7 characters.

Expiry date (MM/YYYY).

EXPIRY

Data

Value

Data type

Numeric with special characters, up to 7 characters.

Description

Expiry date (MM/YYYY).

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.

Table 18. Data Type
Parameter	Data Type
`FAILUREURL`	Alphabetic with special characters.

FALLBACK

Parameter Data Type Value Description

FALLBACK

Boolean.

FALSE

If the card is not registered for 3DS, no authorization attempt is made.

TRUE

If the card is not registered for 3DS, an authorization attempt is made.

FALLBACK

Data

Value

Data type

Boolean

Description

FALSE - If the card is not registered for 3DS, no authorization attempt is made.
TRUE - If the card is not registered for 3DS, an authorization attempt is made.

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

FOR

DEPOSIT

Returns all orders in status approved.

APPROVEREVERSAL

Returns all orders in status approved.

DEPOSITREVERAL

Returns all orders in the status posted.

REFUND

Delivers all orders in status credited.

ANYCOMMAND

Deliver all orders, no matter which status.

VIEWING

Deliver all orders, no matter which status.

Query Credits

FOR

REFUNDREVERSAL

Returns all credit notes that can be canceled.

VIEWING

Returns all credit notes that have already been settled.

VIEWING

Returns all credit notes, regardless of their status.

Query Batches

FOR

BATCHCLOSE

Returns all batches in open status.

VIEWING

Returns all batches, no matter which status.

FOR

Data

Value

Query

Query Orders

Data type

Alfabetic

Description

DEPOSIT - Returns all orders in status approved.
APPROVEREVERSAL - Returns all orders in status approved.
DEPOSITREVERAL - Returns all orders in the status posted.
REFUND - Delivers all orders in status credited.
ANYCOMMAND - Deliver all orders, no matter which status.
VIEWING -Deliver all orders, no matter which status.

FOR

Data

Value

Query

Query Credits

Data type

Alfabetic

Description

REFUNDREVERSAL - Returns all batches in open status.
VIEWING - Returns all credit notes that have already been settled.
VIEWING - Returns all credit notes, regardless of their status.

FOR

Data

Value

Query

Query Batches

Data type

Alfabetic

Description

BATCHCLOSE - Returns all batches in open status.
VIEWING -Returns all batches, no matter which status.

INITTYPE

The initiation type should be defined with the parameter INITTYPE. This value is different depending on which payment type is used.

Table 19. Data Type
Parameter	Data Type
`INITTYPE`	Enumeration.

Table 20. Values for parameter `INITTYPE`
Value of parameter `INITTYPE`	Payment method	Description
`3DSECURE`	3DSECURE	Credit card with a 3D-Secure check like Mastercard, VISA, American Express, Diners Club, and Discover.
`CCARD`	Credit Card	Credit card without 3-D Secure check American Express Diners Club, Discover, JCB, MasterCard, Switch/Solo, UATP, VISA.
`CIRCLEK`	Circle K	Circle K gift card
`CVSPHARMACY`	CVS	CVS Pharmacy gift card
`DOLLARGENERAL`	Dollar General	Dollar General gift card
`ELV`	Sepa	Electronic direct debit
`EPS`	EPS	Austrian standard for online bank transfers, also be used for GIROPAY
`INVOICE`	Invoice: Payolution	Purchase on invoice
`OPENBUCKSCARD`	oBucks	oBucks gift card
`PAGOEFECTIVO`	PagoEfectivo	Part of Paysafecard portfolio of cash-based payment methods.
`PAYPAL`	PayPal	PayPal
`PAYSAFECARD`	Paysafecard	paysafecard
`PRZELEWY24`	Przelewy24	Polish online bank transfer
`RIVERTY-INV`	Riverty	Riverty’s invoice.
`RIVERTY-INST`	Riverty	Riverty’s installment.
`SAFETYPAY`	Safetypay	Part of Paysafecard portfolio of cash-based payment methods.
`SOFORTUEBERWEISUNG`	Sofort	sofortüberweisung

Table 21. Values for parameter `INITTYPE`
`3DSECURE`
Data	Value
Payment method	3DSECURE
Description	Credit card with a 3D-Secure check like Mastercard, VISA, American Express, Diners Club, and Discover.
`CCARD`
Data	Value
Payment method	Credit Card
Description	Credit card with a 3D-Secure check like Mastercard, VISA, American Express, Diners Club, and Discover.
`CIRCLEK`
Data	Value
Payment method	Circle K
Description	Circle K gift card
`CVSPHARMACY`
Data	Value
Payment method	CVS
Description	CVS Pharmacy gift card
`DOLLARGENERAL`
Data	Value
Payment method	Dollar General
Description	Dollar General gift card
`ELV`
Data	Value
Payment method	Sepa
Description	Electronic direct debit
`EPS`
Data	Value
Payment method	EPS
Description	Austrian standard for online bank transfers, also be used for GIROPAY
`INVOICE`
Data	Value
Payment method	Invoice: Payolution
Description	Purchase on invoice
`OPENBUCKSCARD`
Data	Value
Payment method	oBucks
Description	oBucks gift card
`PAGOEFECTIVO`
Data	Value
Payment method	PagoEfectivo
Description	Part of Paysafecard portfolio of cash-based payment methods.
`PAYPAL`
Data	Value
Payment method	PayPal
Description	PayPal
`PAYSAFECARD`
Data	Value
Payment method	Paysafecard
Description	PayPal
`PRZELEWY24`
Data	Value
Payment method	Przelewy24
Description	Polish online bank transfer
`RIVERTY-INV`
Data	Value
Payment method	Riverty
Description	Riverty’s invoice.
`RIVERTY-INST`
Data	Value
Payment method	Riverty
Description	Riverty’s installment.
`SAFETYPAY`
Data	Value
Payment method	Safetypay
Description	Part of Paysafecard portfolio of cash-based payment methods.
`SOFORTUEBERWEISUNG`
Data	Value
Payment method	Sofort
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.

Table 22. Data Type
Parameter	Data Type
`IP_ADDRESS`	Alphanumeric with special characters.

IS_RECURRING_TRANSACTION

Parameter Data Type Value Description

IS_RECURRING_TRANSACTION

Boolean.

FALSE

The transaction is a normal back-office payment.

TRUE

The transaction is a recurring credit card payment by the cardholder from the back office.

IS_RECURRING_TRANSACTION

Data

Value

Data Type

Boolean

Description

FALSE - The transaction is a normal back-office payment.
TRUE - The transaction is a recurring credit card payment by the cardholder from the back office.

ISSUE_DATE

Parameter Data Type Description

ISSUE_DATE

Alphanumeric with special characters, fixed 6 characters.

Card issue date (MM/YYY).

ISSUE_DATE

Data

Value

Data Type

Alphanumeric with special characters, fixed 6 characters.

Description

Card issue date (MM/YYY).

ISSUE_NUMBER

Parameter Data Type Description

ISSUE_NUMBER

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

ISO_TRANSACTION_TYPE

Enumeration.

01

Purchase of goods/services.

03

Acceptance check.

10

Account financing.

11

Quasi-cash transaction.

28

Prepaid, activation and charging.

ISO_TRANSACTION_TYPE

Data

Value

Data Type

Enumeration

Description

01 - Purchase of goods/services.
03 - Acceptance check.
10- Account financing.
11 - Quasi-cash transaction.
28 - Prepaid, activation and charging.

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.

Table 23. Data Type
Parameter	Data Type
`LANGUAGE`	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.

Table 24. 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

LOGPATH

Path to the log directory of QTILL. This directory must be inside the LOGROOT.

Table 25. Data Type
Parameter	Data Type
`LOGPATH`	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

MANDATE_ID

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

MANDATE_SIGNATURE_DATE

Date as DD.MM.YYYY.

Date of mandate signature (DD.MM.YYYY).

MANDATE_SIGNATURE_DATE

Data

Value

Data Type

Date as DD.MM.YYYY.

Description

Date of mandate signature (DD.MM.YYYY).

MAXAMOUNT

Parameter Data Type Description

MAXAMOUNT

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

MAXTIMEOPENED

Date/time.

Creation time end.
Format: DD.MM.YYY hh:mm:ss

MAXTIMEOPENED

Data

Value

Data Type

Date/time.

Description

Creation time end.
Format: DD.MM.YYY hh:mm:ss

MAXTIMECLOSED

Parameter Data Type Description

MAXTIMECLOSED

Date/time.

Time of the last change-end.
Format: DD.MM.YYY hh:mm:ss

MAXTIMECLOSED

Data

Value

Data Type

Date/time.

Description

Time of the last change-end.
Format: DD.MM.YYY hh:mm:ss

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_.

Table 26. Data Type
Parameter	Data Type
`MERCHANTKEY`	Alphanumeric with special characters, up to 50 characters.

MERCHANTREFERENCE

Parameter Data Type Description

MERCHANTREFERENCE

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.

In the table below are restrictions for the parameter MERCHANTREFERENCE for different payment methods.

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.
In the table below are restrictions for the parameter MERCHANTREFERENCE for different payment methods.

Table 28. Restrictions for Parameters `ORDERREFERENCE` and `MERCHANTREFERENCE`:
Acquirer	Brand	Data type
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	Invoice	ASCII, up to 128 characters.
PayPal	PayPal	ASCII, up to 128 characters.
Riverty	Riverty	ASCII, up to 254 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.

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

MERCHANT_TOKENIZATION_FLAG

Boolean.

FALSE

If the transaction will not be used for future referencing.

TRUE

If the transaction will be used for future referencing.

MERCHANT_TOKENIZATION_FLAG

Data

Value

Data Type

Boolean.

Description

FALSE - If the transaction will not be used for future referencing.
TRUE - If the transaction will be used for future referencing.

If this parameter is set to TRUE, the CONSUMER_CHALLENGE_INDICATOR also has to be set to 04.

MINAMOUNT

Parameter Data Type Description

MINAMOUNT

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

MINTIMEOPENED

Date/time.

Creation start time.
Format: DD.MM.YYY hh:mm:ss

MINTIMEOPENED

Data

Value

Data Type

Date/time.

Description

Creation start time.
Format: DD.MM.YYY hh:mm:ss

MINTIMECLOSED

Parameter Data Type Description

MINTIMECLOSED

Date/time.

Time of the last change-start.
Format: DD.MM.YYY hh:mm:ss

MINTIMECLOSED

Data

Value

Data Type

Date/time.

Description

Time of the last change-start.
Format: DD.MM.YYY hh:mm:ss

MODIFYBEGINTIME

Parameter Data Type Description

MODIFYBEGINTIME

Date/time.

Time of the last change-start.
Format: DD.MM.YYY hh:mm:ss

MODIFYENDTIME

Parameter Data Type Description

MODIFYENDTIME

Date/time.

Time of the last change-end.
Format: DD.MM.YYY hh:mm:ss

MODIFYENDTIME

Data

Value

Data Type

Date/time.

Description

Time of the last change-end.
Format: DD.MM.YYY hh:mm:ss

ORDERBY

ORDERBY is used for query orders and specifying by which properties objects are sorted.

Query Parameter Value Description

Query Orders

ORDERBY

BRAND

Object properties are sorted by brand in ascending order.

CURRENCY

Object properties are sorted by currency in ascending order.

ORDERNUMBER

Object properties are sorted by order number in ascending order.

BATCHNUMBER

Object properties are sorted by batch number in ascending order.

PAYMENTTYPE

Object properties are sorted by payment type in ascending order.

TIMEMODIFIED

Object properties are sorted by time of last change in ascending order.

TIMECREATED

Object properties are sorted by time of creation in ascending order.

ORDERTEXT

Object properties are sorted by order description in ascending order.

ORDERREFERENCE

Object properties are sorted by order reference in ascending order.

AMOUNT

Object properties are sorted by an amount in ascending order.

Query Credits

ORDERBY

ORDERNUMBER

Object properties are sorted by order number in ascending order.

CREDITNUMBER

Object properties are sorted by credit number in ascending order.

BATCHNUMBER

Object properties are sorted by batch number in ascending order.

PAYMENTTYPE

Object properties are sorted by payment type in ascending order.

TIMEMODIFIED

Object properties are sorted by time of last change in ascending order.

TIMECREATED

Object properties are sorted by time of creation in ascending order.

AMOUNT

Object properties are sorted by an amount in ascending order.

Query Batches

ORDERBY

BATCHNUMBER

Object properties are sorted by batch number in ascending order.

PAYMENTTYPE

Object properties are sorted by payment type in ascending order.

TIMECLOSED

Object properties are sorted by time of execution in ascending order.

TIMEOPENED

Object properties are sorted by time of opening in ascending order.

ORDERBY

Data

Value

Query

Query Orders

Data Type

Alfabetic

Description

BRAND - Object properties are sorted by order number in ascending order.
CURRENCY - Object properties are sorted by currency in ascending order.
ORDERNUMBER - Object properties are sorted by order number in ascending order.
BATCHNUMBER - Object properties are sorted by batch number in ascending order.
PAYMENTTYPE - Object properties are sorted by payment type in ascending order.
TIMEMODIFIED - Object properties are sorted by time of last change in ascending order.
TIMECREATED - Object properties are sorted by time of creation in ascending order.
ORDERTEXT - Object properties are sorted by order description in ascending order.
ORDERREFERENCE - Object properties are sorted by order reference in ascending order.
AMOUNT - Object properties are sorted by an amount in ascending order.

ORDERBY

Data

Value

Query

Query Credits

Data Type

Alfabetic

Description

ORDERNUMBER - Object properties are sorted by order number in ascending order.
CREDITNUMBER - Object properties are sorted by credit number in ascending order.
BATCHNUMBER - Object properties are sorted by batch number in ascending order.
PAYMENTTYPE - Object properties are sorted by payment type in ascending order.
TIMEMODIFIED - Object properties are sorted by time of last change in ascending order.
TIMECREATED - Object properties are sorted by time of creation in ascending order.
AMOUNT - Object properties are sorted by an amount in ascending order.

ORDERBY

Data

Value

Query

Query Batches

Data Type

Alfabetic

Description

BATCHNUMBER - Object properties are sorted by batch number in ascending order.
PAYMENTTYPE - Object properties are sorted by payment type in ascending order.
TIMECLOSED - Object properties are sorted by time of execution in ascending order.
TIMEOPENED - Object properties are sorted by time of opening in ascending order.

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.

Table 29. Data Type
Parameter	Data Type
`ORDERDESCRIPTION`	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.

Table 30. Data Type
Parameter	Data Type
`ORDERNUMBER`	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

ORDERREFERENCE

Alphanumeric with special characters, up to 128 characters.

Order Reference - With the parameter ORDERREFERENCE define a unique transaction ID that will be forwarded to the financial institution.

In the table below are restrictions for the parameter ORDERREFERENCE for different payment methods.

ORDERREFERENCE

Data

Value

Data Type

Alphanumeric with special characters, up to 128 characters.

Description

Order Reference - With the parameter ORDERREFERENCE define a unique transaction ID that will be forwarded to the financial institution.
In the table below are restrictions for the parameter ORDERREFERENCE for different payment methods.

Table 32. Restrictions for Parameters `ORDERREFERENCE` and `MERCHANTREFERENCE`:
Acquirer	Brand	Data type
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	Invoice	ASCII, up to 128 characters.
PayPal	PayPal	ASCII, up to 128 characters.
Riverty	Riverty	ASCII, up to 254 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 ^[1] 1. The parameter `ORDERREFERENCE` becomes mandatory if the Worldline is used as an acquirer.	Maestro SecureCode, Mastercard, Visa	Numeric and special characters between 10 and 64 characters.

ORDERTEXT

Parameter Data Type Description

ORDERTEXT

Alphanumeric with special characters, up to 255 characters.

Order description.
See Optional Response Parameters for Orders as a Basic.

ORDERTEXT

Data

Value

Data Type

Alphanumeric with special characters, up to 255 characters.

Description

Order description.
See Optional Response Parameters for Orders as a Basic.

ORIGINATOR

Parameter Data Type Description

ORIGINATOR

Alphanumeric with 50 characters.

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.

ORIGINATOR

Data

Value

Data Type

Alphanumeric with 50 characters.

Description

OVERWRITE_WAKEUPMESSAGE

Parameter Data Type Value Description

OVERWRITE_WAKEUPMESSAGE

Boolean.

FALSE

Wakeupmessage contains a reference to about:blank, which may lead to a security warning in the browser.

TRUE

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

FALSE - Wakeupmessage contains a reference to about:blank, which may lead to a security warning in the browser.
TRUE - 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.

PAN

Parameter Data Type Description

PAN

Numeric, up to 19 digits.

Credit card number.

As an alternative to the card number and expiration date, the original order number can be used to reuse existing card data.

PAN

Data

Value

Data Type

Numeric, up to 19 digits.

Description

Credit card number.
As an alternative to the card number and expiration date, the original order number can be used to reuse existing card data.

PAYMENTNUMBER

The value of the parameter PAYMENTNUMBER is identical to the ORDERNUMBER.

Table 33. Data Type
Parameter	Data Type
`PAYMENTNUMBER`	Numeric, up to 9 digits.

PAYMENTTYPE

The PAYMENTTYPE parameter is the name of the payment method the user selected in the online shop.

Table 34. Data Type
Parameter	Data Type
`PAYMENTTYPE`	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!

Table 35. Values for parameter `PAYMENTTYPE`
Value of parameter `PAYMENTTYPE`	Payment method	Mandatory parameter
`CREDITCARD`	Credit Card, Maestro SecureCode	no
`CREDITCARD`	Credit Card-Mail Order and Telephone Order	no
`EPS`	EPS	no
`PAYSAFECARD`	Circle K	yes
	CVS	yes
	Dollar General	yes
	oBucks	yes
	Paysafecard	yes
	Safetypay	yes
	PagoEfectivo	yes
`PAYPAL`	PayPal	yes
`PAYOLUTION`	Invoice: Payolution	no
`PRZELEWY24`	Przelewy24	no
`RIVERTY`	Riverty Invoice	yes
`RIVERTY`	Riverty Installment	yes
`WCP`	SEPA	yes
`HOBEX`	SEPA	yes
`SOFORTUEBERWEISUNG`	Sofort	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

PERIODIC_TYPE

Enumeration.

ci

When the cardholder initiates the transaction.

ucof

When the merchant initiates the transaction. For unscheduled recurring payments with different amounts.

recurring

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

PERIODIC_TYPE

Data

Value

Data Type

Enumeration.

Description

ci - When the cardholder initiates the transaction.
ucof - When the merchant initiates the transaction. For unscheduled recurring payments with different amounts.
recurring - For recurring payments like subscriptions with the same interval and same amount.

REFERENCENUMBER

Parameter Data Type Description

REFERENCENUMBER

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

RETURNATMOST

Numeric, up to 9 characters.

Number of objects that will be returned.

For technical reasons, the result set can be up to twice this value.

RETURNATMOST

Data

Value

Data Type

Numeric, up to 9 characters.

Description

Number of objects that will be returned.
For technical reasons, the result set can be up to twice this value.

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

SERVICEURL

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

SKIPFIRST

Numeric, up to 9 characters.

Start of the result.
The first objects of this value are skipped. Only the ones after it will be returned.

This parameter can be used in combination with RETURNATMOST to return any number of objects.

SKIPFIRST

Data

Value

Data Type

Numeric, up to 9 characters.

Description

Start of the result.
The first objects of this value are skipped. Only the ones after it will be returned.
This parameter can be used in combination with RETURNATMOST to return any number of objects.

SOURCEORDERNUMBER

Parameter Data Type Description

SOURCEORDERNUMBER

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

STATE

Date/time.

open

for open stacks.

closed

for closed stacks.

STATE

Data

Value

Data Type

Date/time.

Description

open - for open stacks.
closed - for closed stacks.

SUCCESSURL

The SUCCESSURL parameter defines the URL of the online shop where the consumer is forwarded when the payment process has been completed.

Table 36. Data Type
Parameter	Data Type
`SUCCESSURL`	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

TRANSACTION_IDENTIFIER

Enumeration.

SINGLE

For a one-time payment.

INITIAL

For initial transactions in a subscription model.

RECUR

For subsequent transactions in a subscription model (requires the mandate reference to be specified).

TRANSACTION_IDENTIFIER

Data

Value

Data Type

Enumeration

Description

SINGLE - For a one-time payment.
INITIAL - For initial transactions in a subscription model.
RECUR -For subsequent transactions in a subscription model (requires the mandate reference to be specified).

TRANSACTION_TYPE

Table 37. Data Type
Parameter	Data Type	Description
`TRANSACTION_TYPE`	Enumeration.	Overwrites transaction type used when processing the order for a refund. `CREDIT`: Refund is explicitly processed as a credit note.

TRANSACTION_TYPE

Data

Value

Data Type

Enumeration

Description

Overwrites transaction type used when processing the order for a refund.
CREDIT - Refund is explicitly processed as a credit note.

USER_AGENT

Parameter Data Type Description

USER_AGENT

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

WAKEUPMESSAGE_METHOD

Enumeration.

FRAME

Wakupmessage consists of an IFrame in which the ACS or CVC page is opened.

PAGE

Wakupmessage contains a simple form redirect to the ACS or CVC page.

POPUP

Wakeupmessage opens a new window.

SCROLLING_FRAME

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

FRAME - Wakupmessage consists of an IFrame in which the ACS or CVC page is opened.
PAGE - Wakupmessage contains a simple form redirect to the ACS or CVC page.
POPUP - Wakeupmessage opens a new window.
SCROLLING_FRAME - Wakeupmessage consists of an IFrame with an activated scrollbar in which the ACS or CVC page is opened.

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.

Table 38. Data Type
Parameter	Data Type
`WINDOWNAME`	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

batches

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

body

HTTP body of the Wake-Up Message.

This parameter is included only for asynchronous initiation types, in case of successful initiation.

body

Data

Value

Description

HTTP body of the Wake-Up Message.
This parameter is included only for asynchronous initiation types, in case of successful initiation.

creditNumber

Parameter Data Type Description

creditNumber

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

credits

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

errorCode

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

Parameter Description

header

HTTP header of the Wake-Up Message.

This parameter is included only for asynchronous initiation types, in case of successful initiation.

header

Data

Value

Description

HTTP header of the Wake-Up Message.
This parameter is included only for asynchronous initiation types, in case of successful initiation.

message

Parameter Data Type Description

message

Alphanumeric with special characters.

Error message.

message

Data

Value

Data Type

Alphanumeric with special characters.

Description

Error message.

objectsTotal

Parameter Data Type Description

objectsTotal

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

orders

Numeric

Always 1 if the operation itself was successful.

orders

Data

Value

Data Type

Numeric

Description

Always 1 if the operation itself was successful.

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.

Table 39. Data Type
Parameter	Data Type
`originator`	Alphanumeric with 50 characters.

paySysMessage

Parameter Data Type Description

paySysMessage

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

status

Numeric, fixed length of 1.

0

Command was executed successfully.

1

Error during parameter check.

2

Rejection of the transaction.

3

Error message from payment server/financial service provider.

4

Internal/expected error.

status

Data

Value

Data Type

Numeric, fixed length of 1.

Description

0 - Command was executed successfully.
1 - Error during parameter check.
2 - Rejection of the transaction.
3 - Error message from payment server/financial service provider.
4 - Internal/expected error.

version

Every response has a version parameter, and this value specifies the version of the QTILL server, eg. „qtillserver 3.23.0.47".

Table 40. Data Type
Parameter	Data Type
`version`	Alphanumeric with special characters.