Response Parameters

Response Parameters

The number of response parameters is not fixed but depends on the payment method.

Use exact names and values of parameters.
Check all responses of the QENTA Checkout Server by using the fingerprint method.

State Parameters

Table 1. State Parameters
Parameter Data type Description

paymentState

Enumeration

Result of payment process: SUCCESS, CANCEL, FAILURE or PENDING.

Successful or Pending Payments

Table 2. Successful or Pending Payments
Parameter Data type Description

financialInstitution

Enumeration

Sub-selection of financial institutions regarding to pre-selected payment method.

language

Alphabetic, fixed 2 characters

Language used for displayed texts on payment page.

orderNumber

Numeric value, up to 9 digits

Unique number identifying the payment.

paymentType

Enumeration

Selected payment method of your consumer.

responseFingerprint

Alphanumeric with a fixed length of 128.

Returned fingerprint of the parameter values as given in the requestFingerprintOrder.

responseFingerprintOrder

Alphanumeric with special characters

Ordered list of parameters used for calculating the fingerprint.

Table 3. Additionaly for Successful Payments
Parameter Data type Description

amount

Amount

AmountOfPayment.

currency

Alphabetic, fixed 3 characters

Currency code of amount.

gatewayContractNumber

Alphanumeric with special characters, up to 255 characters

Contract number of the processor or acquirer.

gatewayReferenceNumber

Alphanumeric with special characters, up to 255 characters

Technical reference number of the processor.

providerReferenceNumber

Alphanumeric with special characters, up to 255 characters

Technical reference number of the financial service provider or acquirer.

Failed Payments

Table 4. Failed Payments for QPAY Checkout Page
Parameter Data type Description

message

Alphanumeric with special characters

Error text describing the failure.

providerMessage

Alphanumeric with special characters

Specific error provided by the acquirer/issuer. If this parameter is not sent for your customerId get in contact with the integrations specialists.

paySysMessage

Alphanumeric with special characters.

Error message specific to payment method and financial institution which is only relevant for the merchant.

consumerMessage

Alphanumeric with special characters

Error message in localized language for your consumer.

Table 5. Failed Payments for QMORE Checkout Seamless
Parameter Data type Description

errors

Numeric

Number of errors occurred.

error.{n}.errorCode

Numeric, fixed 5 characters

Numeric error code which you should log for later use.

error.{n}.message

Alphanumeric with special characters

Error message in English.

error.{n}.consumerMessage

Alphanumeric with special characters

Error message in localized language for your consumer.

error.{n}.paySysMessage

Alphanumeric with special characters

Payment method system-specific error message only relevant for a merchant.

providerMessage

Alphanumeric with special characters

Specific error provided by the acquirer/issuer. If this parameter is not sent for your customerId get in contact with the integrations specialists.

Feature-Specific Parameters

Table 6. Feature-Specific Parameters
Parameter State Data type

liabilityShiftIndicator

Success

Alphabetic, fixed 1 character and possible value of Y or N.

Only available and returns Y if it indicates liability shift; otherwise, the parameter is not returned or returns N. An exception exists for corporate cards and interregional transactions.

instrumentCountry

Success

Alphabetic, fixed 2 characters.

Country of the consumer which has been detected and returned by the financial service provider. It’s not provided by all financial service providers!

Optional Feature Specific Parameter

Table 7. Optional Feature Specific Parameter for QPAY and QMORE
Parameter State Data type Description

hashedPan

Success

Alphanumeric with a fixed length of 128 (hash mechanism HMAC-SHA-512).

Hashed credit card number.

The parameter can be used to check if a certain credit card has been used by your consumer before, i.e. for recognizing a new registration with a different name but with the same credit card. You can safely store this hash without circumventing PCI compliance.

Be aware that due to PCI DSS compliance hashedPan can’t be returned either with maskedPan nor anonymousPan.
Table 8. Optional Feature Specific Parameters for QPAY Checkout Page
Parameter State Data type Description

cardholder

Success

Alphabetic with a variable length of up to 80.

Name of holder of credit card which can only be used if the acquirer supports it.

expiry

Success

Numeric with special characters and a fixed length of 7.

Expiry date of credit card in format mm/yyyy.

maskedPan

Success

Numeric with special characters and a variable length of up to 19.

PCI-compliant masked card number in the format: first 6 digits and last 4 digits of card number with "*" in-between depending on the current format of the card number.

Credit Card

Table 9. Additional Response Parameters
Parameter State Data type Description

anonymousPan

Success

Numeric with 4 numbers.

Last four digits of the credit card number.

authenticated

Success

Boolean

Returns YES if the cardholder has been successfully authenticated; otherwise NO.

The parameter authenticated is always returned if the payment was successful. If the consumer was authenticated by an additional security method, such as 3-D Secure, Mastercard ID Check, Visa Secure, YES will be returned.

PayPal

Table 10. Additional Parameters for PayPal
Parameter State Data type Description

gatewayReferenceNumber

Success

Alphanumeric with special characters, up to 255.

Transaction ID of authorization.

paypalBillingAgreementID

Success

Alphanumeric, up to 19.

Billing agreement ID returned by PayPal.

paypalPayerAddressCity

Success

Alphanumeric, up to 40 characters.

City of shipping address.

paypalPayerAddressCountry

Success

Alphabetic, up to 50.

Country of shipping address.

paypalPayerAddressCountryCode

Success

Alphabetic, fixed length of 2.

Country code (ISO 3166-1) of shipping address.

paypalPayerAddressName

Success

Alphanumeric with a variable length of up to 32.

Name of shipping address.

paypalPayerAddressState

Success

Alphanumeric with a variable length of up to 32.

State of shipping address.

paypalPayerAddressStreet1

Success

Alphanumeric with a variable length of up to 40.

Street line 1 of shipping address.

paypalPayerAddressStreet2

Success

Alphanumeric with a variable length of up to 100.

Street line 2 of shipping address.

paypalPayerAddressStreet2

Success

Alphanumeric with a variable length of up to 20.

ZIP code of shipping address.

paypalPayerEmail

Success

Alphanumeric with special characters and a variable length of up to 127.

E-mail address of consumer as returned by PayPal.

paypalPayerFirstName

Success

Alphanumeric with a variable length of up to 64.

First name of the consumer as returned by PayPal.

paypalPayerID

Success

Alphanumeric with a variable length of up to 13.

ID of the consumer as returned by PayPal.

paypalPayerLastName

Success

Alphanumeric with a variable length of up to 64.

Last name of the consumer as returned by PayPal.

When a consumer enters billing or shipping information after initialization e.g. when using QPBL PayByLink these data are contained in the confirmation sent to the confirmUrl.

Table 11. Parameter
Parameter Data type Description

purchaseInformation

String, Base64 encoded JSON

Contains all consumer information in JSON format.

Sofort

Table 12. Parameters For Sofort
Parameter State Data type Description

securityCriteria

Success

Numeric, fixed 1.

Always set to 1 to provide for backward compatibility.

senderAccountNumber

Success

Numeric, up to 30.

Account number of the sender as returned by Sofort.

senderAccountOwner

Success

Alphanumeric with special characters, up to 255.

Owner of account as returned by Sofort.

senderBankName

Success

Alphanumeric with special characters, up to 255.

Name of a bank as returned by Sofort.

senderBankNumber

Success

Numeric, up to 30.

Number of banks as returned by Sofort.

senderBIC

Success

Alphanumeric, up to 50.

BIC of the sender as returned by Sofort.

senderCountry

Success

Alphabetic, fixed 2.

Country code of sender as returned by Sofort.

senderIBAN

Success

Alphanumeric, up to 50.

IBAN of the sender as returned by Sofort.

SEPA

Table 13. Parameters for SEPA
Parameter Data type Descritpion

creditorId

Alphanumeric, up to 35.

Unique identification of creditor.

dueDate

Date as DD.MM.YYYY

Date when payment is debited from consumer’s bank account.

mandateId

Alphanumeric, up to 35.

Identifier of the displayed mandate.

mandateSignatureDate

Date as DD.MM.YYYY

Date when the mandate was signed by the consumer.