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	Value
`paymentState`	Enumeration	Result of payment process	`SUCCESS`
			`CANCEL`
			`FAILURE`
			`PENDING`

Table 2. State Parameters
`paymentState`
Data	Value
Data type	Enumeration
Description	Result of payment process: SUCCESS CANCEL FAILURE PENDING

Successful or Pending Payments

Table 3. 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 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 4. Successful or Pending Payments
`financialInstitution`
Data	Value
Data type	Enumeration
Description	Sub-selection of financial institutions regarding to pre-selected payment method.
`language`
Data	Value
Data type	Alphabetic, fixed 2 characters
Description	Language used for displayed texts on payment page.
`orderNumber`
Data	Value
Data type	Numeric value, up to 9 digits
Description	Unique number identifying the payment.
`paymentType`
Data	Value
Data type	Enumeration
Description	Selected payment method of consumer.
`responseFingerprint`
Data	Value
Data type	Alphanumeric with a fixed length of 128.
Description	Returned fingerprint of the parameter values as given in the `requestFingerprintOrder`.
`responseFingerprintOrder`
Data	Value
Data type	Alphanumeric with special characters.
Description	Ordered list of parameters used for calculating the fingerprint.

Table 5. Additionally 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.

Table 6. Additionally for Successful Payments
`amount`
Data	Value
Data type	Amount
Description	AmountOfPayment.
`currency`
Data	Value
Data type	Alphabetic, fixed 3 characters
Description	Currency code of amount.
`gatewayContractNumber`
Data	Value
Data type	Alphanumeric with special characters, up to 255 characters
Description	Contract number of the processor or acquirer.
`gatewayReferenceNumber`
Data	Value
Data type	Alphanumeric with special characters, up to 255 characters
Description	Technical reference number of the processor.
`providerReferenceNumber`
Data	Value
Data type	Alphanumeric with special characters, up to 255 characters
Description	Technical reference number of the financial service provider or acquirer.

Failed Payments

Table 7. 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 `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 consumer.

Table 8. 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 should be logged 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 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 `customerId` get in contact with the integrations specialists.

Table 9. Failed Payments for QMORE Checkout Seamless
`errors`
Data	Value
Data type	Numeric
Description	Number of errors occurred.
`error.{n}.errorCode`
Data	Value
Data type	Numeric, fixed 5 characters
Description	Numeric error code which should be logged for later use.
`error.{n}.message`
Data	Value
Data type	Alphanumeric with special characters
Description	Error message in English.
`error.{n}.consumerMessage`
Data	Value
Data type	Alphanumeric with special characters
Description	Error message in localized language for consumer.
`error.{n}.paySysMessage`
Data	Value
Data type	Alphanumeric with special characters
Description	Payment method system-specific error message only relevant for a merchant.
`providerMessage`
Data	Value
Data type	Alphanumeric with special characters
Description	Specific error provided by the acquirer/issuer. If this parameter is not sent for `customerId` get in contact with the integrations specialists.

Feature-Specific Parameters

Table 10. Feature-Specific Parameters
Parameter	State	Data type	Description
`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!

Table 11. Feature-Specific Parameters
`liabilityShiftIndicator`
Data	Value
State	Success
Data type	Alphabetic, fixed 1 character and possible value of `Y` or `N`.
Description	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`
Data	Value
State	Success
Data type	Alphabetic, fixed 2 characters.
Description	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 12. 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 consumer before, i.e. for recognizing a new registration with a different name but with the same credit card. 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 13. 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 14. 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.

Table 15. Parameters for iDeal
Parameter	Data type	Descritpion	idealConsumerIBAN
`Alphanumeric with a variable length of up to 255.`	IBAN of account.	idealConsumerBIC	Alphanumeric with a variable length of 1 to 255.
`BIC of bank.`	idealConsumerName	Alphabetic with a variable length of up to 255.	Name of account owner as returned by iDEAL issuer.

PayPal

Table 16. 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.
`paypalPayerAddressZIP`	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.

Table 17. Additional Parameters for PayPal
`gatewayReferenceNumber`
Data	Value
State	Success
Data type	Alphanumeric with special characters, up to 255.
Description	Transaction ID of authorization.
`paypalBillingAgreementID`
Data	Value
State	Success
Data type	Alphanumeric, up to 19.
Description	Billing agreement ID returned by PayPal.
`paypalPayerAddressCity`
Data	Value
State	Success
Data type	Alphanumeric, up to 40 characters.
Description	City of shipping address.
`paypalPayerAddressCountry`
Data	Value
State	Success
Data type	Alphabetic, up to 50.
Description	Country of shipping address.
`paypalPayerAddressCountryCode`
Data	Value
State	Success
Data type	Alphabetic, fixed length of 2.
Description	Country code (ISO 3166-1) of shipping address.
`paypalPayerAddressName`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 32.
Description	Name of shipping address.
`paypalPayerAddressState`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 32.
Description	State of shipping address.
`paypalPayerAddressStreet1`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 40.
Description	Street line 1 of shipping address.
`paypalPayerAddressStreet2`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 100.
Description	Street line 2 of shipping address.
`paypalPayerAddressZIP`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 20.
Description	ZIP code of shipping address.
`paypalPayerEmail`
Data	Value
State	Success
Data type	Alphanumeric with special characters and a variable length of up to 127.
Description	E-mail address of consumer as returned by PayPal.
`paypalPayerFirstName`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 64.
Description	First name of the consumer as returned by PayPal.
`paypalPayerID`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 13.
Description	ID of the consumer as returned by PayPal.
`paypalPayerLastName`
Data	Value
State	Success
Data type	Alphanumeric with a variable length of up to 64.
Description	Last name of the consumer as returned by PayPal.

QPBL PayByLink

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 18. Parameter
Parameter	Data type	Description
`purchaseInformation`	String, Base64 encoded JSON	Contains all consumer information in JSON format.

Sofort

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

Table 20. Parameters For Sofort
`securityCriteria`
Data	Value
State	Success
Data type	Numeric, fixed 1.
Description	Always set to `1` to provide for backward compatibility.
`senderAccountNumber`
Data	Value
State	Success
Data type	Numeric, up to 30.
Description	Account number of the sender as returned by Sofort.
`senderAccountOwner`
Data	Value
State	Success
Data type	Alphanumeric with special characters, up to 255.
Description	Owner of account as returned by Sofort.
`senderBankName`
Data	Value
State	Success
Data type	Alphanumeric with special characters, up to 255.
Description	Name of a bank as returned by Sofort.
`senderBankNumber`
Data	Value
State	Success
Data type	Numeric, up to 30.
Description	Number of banks as returned by Sofort.
`senderBIC`
Data	Value
State	Success
Data type	Alphanumeric, up to 50.
Description	BIC of the sender as returned by Sofort.
`senderCountry`
Data	Value
State	Success
Data type	Alphabetic, fixed 2.
Description	Country code of sender as returned by Sofort.
`senderIBAN`
Data	Value
State	Success
Data type	Alphanumeric, up to 50.
Description	IBAN of the sender as returned by Sofort.

SEPA

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

Table 22. Parameters for SEPA
`creditorId`
Data	Value
Data type	Alphanumeric, up to 35.
Description	Unique identification of creditor.
`dueDate`
Data	Value
Data type	Date as `DD.MM.YYYY`
Description	Date when payment is debited from consumer’s bank account.
`mandateId`
Data	Value
Data type	Alphanumeric, up to 35.
Description	Identifier of the displayed mandate.
`mandateSignatureDate`
Data	Value
Data type	Date as `DD.MM.YYYY`
Description	Date when the mandate was signed by the consumer.

EPS-GIROPAY

Table 23. Parameters for EPS-GIROPAY
Parameter	Data type	Description
`epsConsumerIBAN`	Alphanumeric, up to 50.	IBAN of the sender as returned by PSA.
`epsConsumerBIC`	Alphanumeric, up to 50.	BIC of the sender as returned by PSA.
`epsConsumerName`	Alphanumeric, up to 50.	Name of the sender as returned by PSA. .