Response Parameters

Backend Response Parameters

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

Always use the same upper and lower case writing of the parameter names and values as described. Check all responses of the QENTA Checkout Server by using the fingerprint method.

For each backend operation these response parameters will always be returned.

Table 1. Parameter Status

Parameter

Data type

Description

Value of parameter status

status

Numeric, fixed length of 1.

Number representing the status of the operation.

0- Operation is successfully done,
1- Error during request parameter verification,
2- Execution of operation denied,
3- Error within an external financial institution,
4- Internal error.

Additional response parameters are returned which are specific to the particular backend operation, both transaction-based and non-transaction-based operations.

If the backend operation was not successful parameters describing the error are returned.
Table 2. Error Parameters for QPAY Checkout Page
Parameter Data type Description

errorCodes

Numeric, fixed 5.

Numeric error code which you should log for later use.

message

Alphanumeric with special characters.

Error message in English.

paySysMessage

Alphanumeric with special characters.

Error message specific to payment method and financial institution which is only relevant for the 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.

Table 3. Error Parameters for QMORE Checkout Seamless
Parameter Data type Description

errors

Numeric

Number of errors occurred.

error.{n}.errorCodes

Numeric, fixed 5.

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

Available Transaction Based Operations

Table 4. Backend Operations
Parameter Data type Description

orderNumber

Numeric, up to 9 digits.

Order number of payment.

Table 5. Source Orders Based on SEPA Direct Debit
Parameter Date type Description

dueDate

Date as DD.MM.YYYY

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

mandateId

Alphanumeric, up to 35 characters.

Identifier of displayed mandate.

mandateSignatureDate

Date as DD.MM.YYYY

Date when the mandate was signed by the consumer.

Table 6. deposit
Parameter Data type Description

paymentNumber

Numeric, up to 9 digits.

A new payment number is returned if a new payment object has been created due to a split capture.

Table 7. refund
Parameter Data type Description

creditNumber

Numeric, fixed 9.

Number of a credit note.

Table 8. transferFund
Parameter Data type Description

creditNumber

Numeric, up to 9 digits.

Number of a credit note.

getOrderDetails Operations

Some parameters will occur more than once, so we use the letters n and m as placeholders for digits. Currently, n is always 1 because getOrderDetails returns only one order and m indicates that there may be more than one payment or credit object returned.

Table 9. Additional Response Parameters
Parameter Data type Description

orders

Numeric

Always 1 if a corresponding order has been found; otherwise 0.

order.{n}.merchantNumber

Numeric, fixed 9 digits.

ID of merchant.

order.{n}.orderNumber

Numeric, up to 9 digits.

Order number.

order.{n}.paymentType

Alphanumeric, up to 32 characters.

Payment type of order.

order.{n}.amount

Amount

Amount of order.

order.{n}.brand

Alphanumeric, up to 255 characters.

Brand of payment method.

order.{n}.currency

Alphabetic or numeric, fixed 3 characters

Currency code of amount.

order.{n}.orderDescription

Alphanumeric, up to 255 characters.

Unique description of the consumer’s order in a human readable form.

order.{n}.acquirer

Alphanumeric

Acquirer

order.{n}.contractNumber

Alphanumeric including special characters, up to 255 characters.

Contract number of financial service provider.

order.{n}.operationsAllowed

Alphanumeric including special characters.

Comma-separated string of available backend operations or an empty string if no backend operation is possible.

order.{n}.orderReference

Numeric, up to 128 digits.

Order reference.

order.{n}.customerStatement

Alphanumeric, up to 254 characters that may be restricted for specific payment methods.

Text visible for consumer on bank statement.

order.{n}.orderText

Alphanumeric, up to 254 characters.

Order text reduced to ASCII-character set.

order.{n}.timeCreated

Date

Date and time when order has been created.

order.{n}.timeModified

Date

Date and time when order has been modified the last time.

order.{n}.state

Alphanumeric, up to 16 characters.

Current state of order -ORDERED, REFUNDABLE.

order.{n}.sourceOrderNumber

Numeric, up to 9 digits.

Source order number if there is a connection to another order.

order.{n}.payments

Numeric

Count of corresponding payment objects.

order.{n}.credits

Numeric

Count of corresponding credit objects.

payment.{n}.{m}.merchantNumber

Numeric

ID of merchant.

payment.{n}.{m}.paymentNumber

Numeric, up to 9 digits.

Number of payment.

payment.{n}.{m}.orderNumber

Numeric, up to 9 digits.

Number of order.

payment.{n}.{m}.approvalCode

Alphanumeric

Approval code of financial service provider, may be an empty string.

payment.{n}.{m}.batchNumber

Numeric, up to 9 digits.

Only available if day-end closing was done the order.

payment.{n}.{m}.approveAmount

Amount

Approved amount of order.

payment.{n}.{m}.depositAmount

Amount

Debit amount of order.

payment.{n}.{m}.currency

Alphabetic or numeric, fixed 3 characters

Currency code.

payment.{n}.{m}.timeCreated

Date

Date and time when payment has been created.

payment.{n}.{m}.timeModified

Date

Date and time when payment has been modified the last time.

payment.{n}.{m}.state

Alphabetic, up to 32 characters.

Current state of payment-payment_approved, payment_deposited, payment_closed, payment_approvalexpired.

payment.{n}.{m}.paymentType

Alphanumeric, up to 64 characters.

Technical property used for the transaction.

payment.{n}.{m}.operationsAllowed

Alphanumeric including special characters.

Comma-separated string of available backend operations or an empty string if no backend operation is possible.

payment.{n}.{m}.gatewayReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Technical reference number of corresponding financial service provider.

payment.{n}.{m}.providerReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Technical reference number of the corresponding financial service provider or acquirer.

payment.{n}.{m}.avsResultCode

Alphanumeric including special characters, up to 5 characters.

Result code of AVS check.

payment.{n}.{m}.avsResultMessage

Alphanumeric including special characters and up to 256 characters.

Result text of AVS check.

payment.{n}.{m}.avsProviderResultCode

Alphanumeric including special characters, up to 5 characters.

Provider result code of AVS check.

payment.{n}.{m}.avsProviderResultMessage

Alphanumeric including special characters, up to 256 characters.

Provider result text of AVS check.

credit.{n}.{m}.merchantNumber

Numeric

ID of merchant.

credit.{n}.{m}.creditNumber

Numeric, up to 9 digits.

Credit number.

credit.{n}.{m}.orderNumber

Numeric, up to 9 digits.

Order number.

credit.{n}.{m}.batchNumber

Numeric, up to 9 digits.

Batch number for corresponding day-end closing.

credit.{n}.{m}.amount

Amount

Amount of credit.

credit.{n}.{m}.currency

Alphabetic or numeric, fixed 3 characters

Currency code of amount.

credit.{n}.{m}.timeCreated

Date

Date and time when credit has been created.

credit.{n}.{m}.timeModified

Date

Date and time when credit has been modified the last time.

credit.{n}.{m}.state

Alphabetic including special characters.

Current state of credit-credit_refunded, credit_closed.

credit.{n}.operationsAllowed

Alphanumeric including special characters.

Comma-separated string of available backend operations or an empty string if no backend operation is possible.

credit.{n}.{m}.gatewayReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Technical reference number of corresponding financial service provider.

credit.{n}.{m}.providerReferenceNumber

Alphanumeric including special characters, up to 255 characters.

Technical reference number of corresponding financial service provider or acquirer.

Table 10. PayPal
Parameter Data type Description

payment.{n}.{m}.paypalPayerID

Alphanumeric, up to 13 characters.

ID of PayPal consumer.

payment.{n}.{m}.paypalBillingAgreementID

Alphanumeric including special characters, up to 19 characters.

Billing agreement ID created by PayPal which can be used for recurring payments.

payment.{n}.{m}.paypalPayerEmail

Alphanumeric including special characters, up to 127 characters.

E-mail of PayPal consumer.

payment.{n}.{m}.paypalPayerFirstName

Alphanumeric, up to 64 characters.

First name of PayPal consumer.

payment.{n}.{m}.paypalPayerLastName

Alphanumeric, up to 64 characters.

Last name of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressCountry

Alphabetic, up to 50 characters.

Country of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressCountryCode

Alphabetic, fixed 2 characters.

Country code (ISO 3166-1) of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressCity

Alphabetic, up to 40 characters.

Ciy of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressState

Alphabetic, fixed 2 characters.

State of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressName

Alphanumeric, up to 100 characters.

Address name of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressStreet1

Alphanumeric, up to 100 characters.

Street (1) of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressStreet2

Alphanumeric, up to 100 characters.

Street (2) of PayPal consumer.

payment.{n}.{m}.paypalPayerZIP

Alphanumeric, up to 32 characters.

Zip code of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressStatus

Alphanumeric, up to 32 characters.

State of address verification of PayPal consumer.

payment.{n}.{m}.paypalPayerProtectionEligibility

Alphanumeric, up to 32 characters.

Information regarding PayPal merchant protection.

Table 11. Sofort
Parameter Data type Description

payment.{n}.{m}.senderAccountOwner

Alphanumeric including special characters, up to 255 characters.

Name of owner of account returned by Sofort.

payment.{n}.{m}.senderAccountNumber

Alphanumeric including special characters, up to 255 characters.

Number of account returned by Sofort.

payment.{n}.{m}.senderBankNumber

Numeric, up to 30 digits.

Bank number of account returned by Sofort.

payment.{n}.{m}.senderBankName

Numeric, up to 30 digits.

Bank number of account returned by Sofort.

payment.{n}.{m}.senderBIC

Alphanumeric, up to 50 characters.

BIC of account returned by Sofort.

payment.{n}.{m}.senderIBAN

Alphanumeric, up to 50 characters.

IBAN of account returned by Sofort.

payment.{n}.{m}.senderCountry

Alphabetic, fixed 2 characters.

Country code of sender returned by Sofort.

payment.{n}.{m}.securityCriteria

Numeric with a fixed length of 1 digit digit.

Security criterion returned values:
1-the criteria were met and 0- criteria were not met, in that case you should wait until the amount has been received on your side before sending goods or grant access to digital media.