Detailed Description of Parameters

Request Parameters

ACCEPT_HEADERS

`ACCEPT_HEADERS`	alphanumeric with special characters ⇐ 4096 characters HTTP header of the consumer’s browser.

ACCEPT_HEADERS

alphanumeric with special characters ⇐ 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

`ACCOUNTID`	alphanumeric ⇐ 9 characters Account-ID.

ACCOUNTID

alphanumeric ⇐ 9 characters
Account-ID.

ACCOUNTID

Data

Value

Data type

Alphanumeric, up to 9 characters.

Description

Account-ID.

ACCOUNT_TYPE

ACCOUNT_TYPE

alphabetic with special characters fixed 6 characters
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.

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 2. Valid Values for the ACCOUNT_TYPE Parameter
ACCOUNT_TYPE	Description
`EPS-SO`	Bank selection hosted by the eps scheme operator.

ADMIN_PASSWORD

ADMIN_PASSWORD

alphabetic fixed 8 characters, but by specification, it can also be ⇐ 128 characters
Key-password.
The parameter is set by our onboarding. For testing, the value of ADMIN_PASSWORD is 9p3a0m5f.

The ADMIN_PASSWORD parameter is mandatory depending on which command is used.

Command ADMIN_PASSWORD

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

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 parameter is set by our onboarding. For testing, the value of ADMIN_PASSWORD is 9p3a0m5f.

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

AMOUNT

numeric with special characters(dot,comma) ⇐ 20 characters
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.

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

APPLICATIONTYPE

alphabetic fixed 1 characters
The parameter APPLICATIONTYPE defines the type of application. For using this integration type, the parameter value has to be S.

BATCHNUMBER

`BATCHNUMBER`	numeric ⇐ 9 characters Daily closing number.

BATCHNUMBER

numeric ⇐ 9 characters
Daily closing number.

BATCHNUMBER

Data

Value

Data type

Numeric, up to 9 digits.

Description

Daily closing number.

`BANK_ACCOUNT_OWNER`	alphanumeric with special characters [ 1 .. 255 ] characters Account holder.

BANK_ACCOUNT_OWNER

alphanumeric with special characters [ 1 .. 255 ] characters
Account holder.

BANK_ACCOUNT_OWNER

Data

Value

Data type

Alphanumeric with special characters, 1 to 255.

Description

Account holder.

BANK_BIC

BANK_BIC

alphanumeric [ 8 .. 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

`BANK_ACCOUNT_IBAN`	alphanumeric [ 16 .. 34 ] characters IBAN of the account. 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

BANK_ACCOUNT_IBAN

alphanumeric [ 16 .. 34 ] characters
IBAN of the account.
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

BANK_ACCOUNT_IBAN

Data

Value

Data type

Alphanumeric, 16 to 34 characters.

Description

IBAN of the account.
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

BRAND

BRAND

enumeration
Brand

CANCELURL

`CANCELURL`	alphanumeric with special characters URL to which the server points in case the customer cancels the transaction. `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.

CANCELURL

alphanumeric with special characters
URL to which the server points in case the customer cancels the transaction.
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.

CANCELURL

Data

Value

Data type

Alphanumeric with special characters.

Description

URL to which server points in case the customer cancels the transaction.
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.

CARDHOLDERNAME

`CARDHOLDERNAME`	alphanumeric with special characters ⇐ 80 characters Cardholder name.

CARDHOLDERNAME

alphanumeric with special characters ⇐ 80 characters
Cardholder name.

CARDHOLDERNAME

Data

Value

Data type

Alphanumeric with special, up to 80 characters.

Description

Cardholder name.

CARDVERIFYCODE

`CARDVERIFYCODE`	numeric ⇐ 4 digits Check the digits of the credit card. Common names are also `CVC2`, `CVV`, and `CID`.

CARDVERIFYCODE

numeric ⇐ 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

COMMAND

alphabetic
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 3. Parameters for Specific Command
Value of parameter `COMMAND`
`APPROVEREVERSAL`
`CREATEORDER`
`DEPOSIT`
`DEPOSITREVERSAL`
`GETORDERDETAILS`
`GETINSTALLMENTPLANS`
`INITIATEPAYMENT`
`PING`
`QUERYBATCHES`
`QUERYCREDITS`
`QUERYORDERS`
`RECURPAYMENT`
`REFUND`
`REFUNDREVERSAL`
`VERIFYPAYMENT`

CONFIRMURL

CONFIRMURL

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

CREATEBEGINTIME

`CREATEBEGINTIME`	string <date-time> Creation start time. Format: `DD.MM.YYY` `hh:mm:ss`

CREATEBEGINTIME

string <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

`CREATEENDTIME`	string <date-time> Creation time end. Format: `DD.MM.YYY` `hh:mm:ss`

CREATEENDTIME

string <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

`CREDITOR_ID`	alphanumeric ⇐ 35 characters Unique ID of the merchant for the processing of SEPA direct debits (assigned by the respective national bank).

CREDITOR_ID

alphanumeric ⇐ 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`	numeric ⇐ 9 digits Credit note number. The parameter 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.

CREDITNUMBER

numeric ⇐ 9 digits
Credit note number.
The parameter 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.

CREDITNUMBER

Data

Value

Data type

Numeric, up to 9 digits.

Description

Credit note number.

CURRENCY

CURRENCY

alphabetic or numeric fixed 3 characters
The parameter defines the currency used in the payment.

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

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

`CONSUMER_PLAN_NUMBER`	numeric ⇐ 1 digits The number of customer installment plans. Depending on the value of the parameter `AMOUNT`, his value is in the range of 1 to 5.

CONSUMER_PLAN_NUMBER

numeric ⇐ 1 digits
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 5. 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

CUSTOMERSTATEMENT

alphanumeric with special characters ⇐ 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 6. 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

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

CONSUMER_MERCHANT_CRM_ID

alphanumeric ⇐ 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

DEPOSITAMOUNT

numeric with special characters(dot, comma) ⇐ 20 characters
The parameter defines 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.

DEPOSITFLAG

DEPOSITFLAG

boolean
Accepted values:

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

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

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

DUE_DATE

string <date-time> [ 5 .. 64 ] characters
Date of mandate signature. The format has to be (DD.MM.YYYY or D.M.YYYY).
The parameter defines the day when payment is debited from the consumer’s bank account. It can be used for initialization and recurring SEPA payment.

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

EXPIRY

numeric with special characters ⇐ 7 characters
Expiry date. The format MM/YYYY.

EXPIRY

Data

Value

Data type

Numeric with special characters, up to 7 characters.

Description

Expiry date (MM/YYYY).

FAILUREURL

FAILUREURL

alphabetic with special characters
The 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 the support team.

FALLBACK

FALLBACK

boolean
Accepted values:

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

alphabetic
The parameter 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.

Accepted values:

Query Value

Query Orders

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

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

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

INITTYPE

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

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

IP_ADDRESS

alphanumeric with special characters
The parameter defines a valid IP address and uses 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.

IS_RECURRING_TRANSACTION

IS_RECURRING_TRANSACTION

boolean
Accepted values:

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

ISSUE_DATE

alphanumeric with special characters fixed 6 characters
Card issue date. Format: MM/YYY.

ISSUE_DATE

Data

Value

Data Type

Alphanumeric with special characters, fixed 6 characters.

Description

Card issue date (MM/YYY).

ISSUE_NUMBER

ISSUE_NUMBER

numeric ⇐ 4 digits
Card sequence number.

ISSUE_NUMBER

Data

Value

Data Type

Numeric, up to 4 digits.

Description

Card sequence number.

ISO_TRANSACTION_TYPE

ISO_TRANSACTION_TYPE

enumeration
The value corresponds to the type of ISO transaction. The values are derived from the ISO 8583 standard.
Accepted values:

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

LANGUAGE

alphabetic fixed 2 characters
The 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.

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

Date/time.

Description

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

MERCHANTKEY

MERCHANTKEY

alphanumeric with special characters ⇐ 50 characters
The parameter 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_.

MERCHANTREFERENCE

MERCHANTREFERENCE

ASCII ⇐ 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.

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

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

MERCHANT_TOKENIZATION_FLAG

boolean
Only used for credit cards and the default value is FALSE.

With the parameter sets the recurring flaggings for specific orders. It has to be set to TRUE to save the consumer’s card details for later use.

Accepted values:

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.

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.

MINAMOUNT

MINAMOUNT

numeric with special characters(dot, comma) ⇐ 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

MINTIMEOPENED

string <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

MINTIMECLOSED

string <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

MODIFYBEGINTIME

string <date-time>
Time of the last change-start. Format: DD.MM.YYY hh:mm:ss

MODIFYBEGINTIME

Data

Value

Data Type

Date/time.

Description

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

MODIFYENDTIME

MODIFYENDTIME

string <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

alphabetic
The parameter is used for query orders and specifying by which properties objects are sorted.

Accepted values:

Query Value

Query Orders

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

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

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

ORDERDESCRIPTION

alphanumeric ⇐ 255 characters
The 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.

ORDERNUMBER

ORDERNUMBER

numeric ⇐ 9 digits
The parameter 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.

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

ORDERREFERENCE

ORDERREFERENCE

alphanumeric with special characters ⇐ 128 characters
The parameter defines 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 14. 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.

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 15. 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 ^[2] 2. 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

ORDERTEXT

alphanumeric with special characters ⇐ 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

ORIGINATOR

alphanumeric ⇐ 50 characters
The user (or the system), who (or which) called this command. The parameter 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

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.

OVERWRITE_WAKEUPMESSAGE

OVERWRITE_WAKEUPMESSAGE

boolean
Accepted values:

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

PAN

numeric ⇐ 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

PAYMENTNUMBER

numeric ⇐ 9 digits
The value of the parameter PAYMENTNUMBER is identical to the ORDERNUMBER.

PAYMENTTYPE

PAYMENTTYPE

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

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

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.

Table 17. Values for parameter `PAYMENTTYPE`
Value of parameter `PAYMENTTYPE`	Payment method	Mandatory parameter
`CREDITCARD`	Credit Card, Maestro SecureCode	mandatory parameter
`CREDITCARD`	Credit Card-Mail Order and Telephone Order	not mandatory parameter
`EPS`	EPS	not mandatory parameter
`PAYSAFECARD`	Circle K	mandatory parameter
	CVS	mandatory parameter
	Dollar General	mandatory parameter
	oBucks	mandatory parameter
	Paysafecard	mandatory parameter
	Safetypay	mandatory parameter
	PagoEfectivo	mandatory parameter
`PAYPAL`	PayPal	mandatory parameter
`PAYOLUTION`	Invoice: Payolution	not mandatory parameter
`PRZELEWY24`	Przelewy24	not mandatory parameter
`RIVERTY`	Riverty Invoice	mandatory parameter
`RIVERTY`	Riverty Installment	mandatory parameter
`WCP`	SEPA	mandatory parameter
`HOBEX`	SEPA	mandatory parameter
`SOFORTUEBERWEISUNG`	Sofort	not mandatory parameter

PERIODIC_TYPE

PERIODIC_TYPE

enumeration
The parameter sets the periodic type of initial and recurring payments.

Accepted values:

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

REFERENCENUMBER

alphanumeric with special characters ⇐ 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

RETURNATMOST

numeric ⇐ 9 digits
The 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

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.

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

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

SKIPFIRST

numeric ⇐ 9 digits
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

SOURCEORDERNUMBER

numeric ⇐ 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

STATE

string <date-time>
Accepted values:

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

SUCCESSURL

alphabetic with special characters
The parameter defines the URL of the online shop where the consumer is forwarded when the payment process has been completed.

TRANSACTION_IDENTIFIER

TRANSACTION_IDENTIFIER

enumeration

Accepted values:

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

The parameter defines 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.

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

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

USER_AGENT

alphanumeric with special characters ⇐ 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

WAKEUPMESSAGE_METHOD

enumeration
Depending on which WAKEUPMESSAGE_METHOD is used, Wakeupmessage is displayed differently.

Accepted values:

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

WINDOWNAME

alphabetic
The parameter defines the name of the pop-up window of iframe where QPAY Checkout Page or an additional payment window is opened.

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 consumers if they have enabled a pop-up blocker within their browsers or if it’s activated by default.

Response Parameters

batches

batches

alphanumeric with special characters
The number of daily closings included in this answer set.

batches

Data

Value

Data Type

Alphanumeric, with special characters.

Description

errorCode

numeric fixed 5 characters
Numeric error code. With errorCode get a numeric error code, which indicates on specific error that occurred.

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

alphanumeric with special characters
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

message

alphanumeric with special characters
Error message.

message

Data

Value

Data Type

Alphanumeric with special characters.

Description

Error message.

objectsTotal

objectsTotal

numeric
A 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

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

originator

alphanumeric ⇐ 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.

paySysMessage

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

status

numeric fixed 1 characters
Every response has a version parameter, and its value specified response status.

Accepted values:

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

version

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