getOrderDetails

getOrderDetails

getOrderDetails is one of the transaction-based operations (back-end operations) offered by QPAY Checkout Page and QMORE Checkout Seamless. This operation returns all details for a given order including all possible operations, corresponding payments and credit notes.

The required order of the parameter values when computing the fingerprint for QPAY Checkout Page is: customerId, shopId, toolkitPassword, secret, command, language and orderNumber.

The required order of the parameter values when computing the fingerprint for QMORE Checkout Seamless is: customerId, shopId, password, secret, language and orderNumber.

Additional required request parameters

Parameter Data type Short description

orderNumber

Numeric with a variable length of up to 9 digits.

Order number of payment.

Additional response parameters

The following parameters are used in addition to the response parameters needed for all back-end operations (QPAY Checkout Page and QMORE Checkout Seamless).

Within the additional response parameters there are some parameters which will occur more than once. Therefore we use the letters "n" and "m" as placeholders for digits. Currently "n" is always 1 because this operation returns only one order. The letter "m" indicates that there may be more than one payment or credit objects returned.

Parameter Data type Short description

orders

Numeric

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

order.{n}.merchantNumber

Numeric with a fixed length of 9 digits.

ID of merchant.

order.{n}.orderNumber

Numeric with a variable length of up to 9 digits.

Order number.

order.{n}.paymentType

Alphanumeric with a variable length of up to 32 characters.

Payment type of order.

order.{n}.amount

Amount

Amount of order.

order.{n}.brand

Alphanumeric with a variable length of up to 255 characters.

Brand of payment method.

order.{n}.currency

Alphabetic with a fixed length of 3 characters or numeric with a fixed length of 3 digits.

Currency code of amount.

order.{n}.orderDescription

Alphanumeric with a variable length of 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 and a variable length of up to 255 characters.

Contract number of financial service provider.

order.{n}.operationsAllowed

Alphanumeric including special characters.

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

order.{n}.orderReference

Numeric with a variable length of up to 128 digits.

Order reference.

order.{n}.customerStatement

Alphanumeric with a variable length of up to 254 characters that may be restricted for specific payment methods.

Text visible for consumer on bank statement.

order.{n}.orderText

Alphanumeric with a variable length of 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 with a variable length of up to 16 characters.

Current state of order (ORDERED, REFUNDABLE).

order.{n}.sourceOrderNumber

Numeric with a variable length of 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 with a variable length of up to 9 digits.

Number of payment.

payment.{n}.{m}.orderNumber

Numeric with a variable length of up to 9 digits.

Number of order.

payment.{n}.{m}.approvalCode

Alphanumeric

Approval code of financial service provider (may be also an empty string).

payment.{n}.{m}.batchNumber

Numeric with a variable length of up to 9 digits.

Only available if day-end closing was done for this order.

payment.{n}.{m}.approveAmount

Amount

Approved amount of order.

payment.{n}.{m}.depositAmount

Amount

Debit amount of order.

payment.{n}.{m}.currency

Alphabetic with a fixed length of 3 characters or numeric with a fixed length of 3 digits.

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 with a variable length of up to 32 characters.

Current state of payment (payment_approved, payment_deposited, payment_closed, payment_approvalexpired).

payment.{n}.{m}.paymentType

Alphanumeric witha variable length of up to 64 characters.

Technical property used for the transaction.

payment.{n}.{m}.operationsAllowed

Alphanumeric including special characters.

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

payment.{n}.{m}.gatewayReferenceNumber

Alphanumeric including special characters with a variable length of up to 255 characters.

Technical reference number of corresponding financial service provider.

payment.{n}.{m}.providerReferenceNumber

Alphanumeric including special characters with a variable length of up to 255 characters.

Technical reference number of corresponding financial service provider or acquirer. [1]

payment.{n}.{m}.avsResultCode

Alphanumeric including special characters with a variable length of 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 with a variable length of up to 5 characters.

Provider result code of AVS check.

payment.{n}.{m}.avsProviderResultMessage

Alphanumeric including special characters with a variable length of up to 256 characters.

Provider result text of AVS check.

payment.{n}.{m}.idealConsumerName

Alphabetic with a variable length of up to 255 characters.

Name of iDEAL consumer.

payment.{n}.{m}.idealConsumerCity

Alphanumeric including special characters and a variable length of up to 255 characters.

City of iDEAL consumer.

payment.{n}.{m}.idealConsumerBIC

Alphanumeric with a variable length of up to 50 characters.

BIC of iDEAL consumer.

payment.{n}.{m}.idealConsumerIBAN

Alphanumeric with a variable length of up to 50 characters.

IBAN of iDEAL consumer.

payment.{n}.{m}.idealConsumerAccountNumber

Alphanumeric with a variable length of up to 255 characters.

Account number of iDEAL consumer.

payment.{n}.{m}.paypalPayerID

Alphanumeric with a variable length of up to 13 characters.

ID of PayPal consumer.

payment.{n}.{m}.paypalBillingAgreementID

Alphanumeric including special characters and 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 and up to 127 characters.

E-mail of PayPal consumer.

payment.{n}.{m}.paypalPayerFirstName

Alphanumeric with a variable length of up to 64 characters.

First name of PayPal consumer.

payment.{n}.{m}.paypalPayerLastName

Alphanumeric with a variable length of up to 64 characters.

Last name of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressCountry

Alphabetic with a variable length of up to 50 characters.

Country of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressCountryCode

Alphabetic with a fixed length of 2 characters.

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

payment.{n}.{m}.paypalPayerAddressCity

Alphabetic with a variable length of up to 40 characters.

Ciy of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressState

Alphabetic with a fixed length of 2 characters.

State of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressName

Alphanumeric with a variable length of up to 100 characters.

Address name of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressStreet1

Alphanumeric with a variable length of up to 100 characters.

Street (1) of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressStreet2

Alphanumeric with a variable length of up to 100 characters.

Street (2) of PayPal consumer.

payment.{n}.{m}.paypalPayerZIP

Alphanumeric with a variable length of up to 32 characters.

Zip code of PayPal consumer.

payment.{n}.{m}.paypalPayerAddressStatus

Alphanumeric with a variable length of up to 32 characters.

State of address verification of PayPal consumer.

payment.{n}.{m}.paypalPayerProtectionEligibility

Alphanumeric with a variable length of up to 32 characters.

Information regarding PayPal merchant protection.

payment.{n}.{m}.senderAccountOwner

Alphanumeric including special characters and up to 255 characters.

Name of owner of account returned by Sofort.

payment.{n}.{m}.senderAccountNumber

Numeric with a variable length of up to 30 digits.

Number of account returned by Sofort.

payment.{n}.{m}.senderBankNumber

Numeric with a variable length of up to 30 digits.

Bank number of account returned by Sofort.

payment.{n}.{m}.senderBankName

Numeric with a variable length of up to 30 digits.

Bank number of account returned by Sofort.

payment.{n}.{m}.senderBIC

Alphanumeric with a variable length of up to 50 characters.

BIC of account returned by Sofort.

payment.{n}.{m}.senderIBAN

Alphanumeric with a variable length of up to 50 characters.

IBAN of account returned by Sofort.

payment.{n}.{m}.senderCountry

Alphabetic with a fixed length of 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 by Sofort where ”1” means the criteria were met and ”0” means 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.

credit.{n}.{m}.merchantNumber

Numeric

ID of merchant.

credit.{n}.{m}.creditNumber

Numeric with a variable length of up to 9 digits.

Credit number.

credit.{n}.{m}.orderNumber

Numeric witha variable length of up to 9 digits.

Order number.

credit.{n}.{m}.batchNumber

Numeric with a variable length of up to 9 digits.

Batch number for corresponding day-end closing.

credit.{n}.{m}.amount

Amount

Amount of credit.

credit.{n}.{m}.currency

Alphabetic with a fixed length of 3 characters or numeric with a fixed length of 3 digits.

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 back-end operations or an empty string if no back-end operation is possible.

credit.{n}.{m}.gatewayReferenceNumber

Alphanumeric including special characters with a variable length of up to 255 characters.

Technical reference number of corresponding financial service provider.

credit.{n}.{m}.providerReferenceNumber

Alphanumeric including special characters with a variable length of up to 255 characters.

Technical reference number of corresponding financial service provider or acquirer. [2]

Feature-specific parameter

This response parameter enhances the result data of the payment process regarding specific features and functions and is enabled by QENTA on your behalf.

To enable this response parameter please contact our support teams.

Parameter Data type Short description

payment.{n}.{m}.instrumentCountry

Alphabetic with a fixed length of 2 characters.

Country of the consumer which has been detected and returned by the financial service provider. Please be aware that this feature is not provided by all financial service providers.

paymentType

The parameter paymentType returns the technical property used for the transaction.

Value Description

APE

Bancontact, Trustly, moneta.ru, Przelewy24, POLi

APG

SIX Payment Services via SIX Card Solutions (formerly First Data Austria, formerly APSS), only credit cards

CPT

CompuTop (credit cards and direct debit system)

EPAY_BG

ePay.bg

EPS2

eps-Überweisung

HBX

Hobex direct debit system

IDEAL

iDEAL

ISO

DC Bank AG

MONETA

moneta.ru

PAYBOX

paybox

PAYPAL

PayPal

PPL

PayPal

PPS

payolution Payment Service (invoice and installment)

PSC

paysafecard

RPY

RatePAY (direct debit, invoice and installment)

SCM

SIX Payment Services via SIX Card Solutions (formerly First Data Austria, formerly APSS), only Maestro SecureCode

SEPA-DD

Direct debit system via Wirecard Bank

SKRILLWALLET

Skrill Digital Wallet

SOFORTBANKING

Sofort. (formerly known as SOFORTÜBERWEISUNG)

SPY

SIX Card Solutions / Saferpay

SUE

Sofort. (formerly known as SOFORTÜBERWEISUNG)

TATRAPAY

TatraPay

TRUSTPAY

TrustPay

VPG

card complete (formerly Visa Austria)

WCP

QENTA Processing (credit cards and direct debit system)

WGP

giropay via QENTA Processing

Changed payment types

Some payment types used for internal processing have been changed in the course of time. The following table gives an overview of all changed payment types.

Outdated value of parameter paymentType Payment method Change detail New value of parameter paymentType

BMC

Bancontact

Bancontact since 2012 processed via APE.

APE

DP

Direct Pay (BAWAG/P.S.K.)

Direct Pay since 2004 processed via EPS2.

EPS2

EPS

eps-Überweisung

eps 1 since 2004 processed via EPS2.

EPS2

IDL

iDEAL

iDEAL since 2013 processed via IDEAL.

IDEAL

NTP

Netpay (Spardat)

Netpay since 2004 processed via EPS2.

EPS2

PBX

paybox

paybox since 2013 processed via PAYBOX.

PAYBOX

POP

Partner Online Paying (BA-CA)

Partner Online Paying since 2004 processed via EPS2.

EPS2

Brand for Credit Cards

Value Payment type

American Express

WCP

Diners Club

ISO, WCP

Discover

ISO, WCP

JCB

SPY, VPG, WCP

Mastercard

APG, VPG, WCP

UATP

WCP

Visa

APG, VPG, WCP

Maestro SecureCode

SCM, VPG, WCP

Mastercard SecureCode

APG, VPG, WCP

Verified by Visa

APG, VPG, WCP

Brand for others

Value Payment type

ARZ

EPS2

BA-CA

EPS2

Bancontact

APE

BAWAG

EPS2

ELBA-Racon

EPS2

ELV

BTV, CPT, HBX, RPY, SEPA, WCP

ePay.bg

EPAY_BG

Hobex

HBX

Hypo-Racon

EPS2

iDEAL

IDL, IDEAL

Installment

PPS, RPY, RATEPAY

Invoice

PPS, RPY, RATEPAY, WIRECARD-RATEPAY

moneta.ru

APE, MONETA

paybox

PBX, EPS2, PAYBOX

PayPal

PPL, PAYPAL

paysafecard

PSC, PAYSAFECARD

POLi

APE

Przelewy24

APE

Skrill Digital Wallet

SKRILLWALLET

sofortueberweisung

SUE, SOFORTBANKING

Spardat

EPS2

TatraPay

TATRAPAY

Trustly

APE

Outdated brands

bill-it-easy

BIE

Cash-Ticket

PSC

one/Orange

MIA

Quick

QIK

T-Mobile

MIA

Switch/Solo

WCP

FAQ

What is the meaning of the return message PENDING?

If the operation getOrderDetails is carried out for order numbers which are still "in progress" in QPAY Checkout Page or QMORE Checkout Seamless, no statement on the actual or final order state may be retrieved and the message PENDING is returned. When repeating the operation getOrderDetails for such order numbers after a while, the message REJECTED might, for instance, be returned.

For this reason, it is recommended to perform the operation getOrderDetails after receiving e.g. the confirmUrl in order to obtain useful and accurate results.

If, however, the operation getOrderDetails is carried out for order numbers "in progress", payments which are in such PENDING state return, for example, the following result:

Message errorCode paySysMessage Status

The final state of the transaction could not yet be determined.

30014

(15/30761) - No payer assigned to EC token.

3

Please be aware that the paySysMessage depends on the relevant financial service provider response.

Currently, error code 30014 is supported by the those payment methods for which the pendingUrl is required or recommended.

What is the meaning of the return message REJECTED?

If the operation getOrderDetails is carried out, payments in status REJECTED return, for example, the following result:

Message errorCode paySysMessage Status

The financial institution has declined the transaction. Please check the data you have entered.

20003

WCP: Auth: Verification failed.

2

Unlike the return message PENDING, the message REJECTED refers to a final state that will not change.

Please be aware that the paySysMessage depends on the relevant financial service provider response.


1. For some systems and payment methods the technical reference number is only available within the gatewayReferenceNumber.
2. For some systems and payment methods the technical reference number is only available within the gatewayReferenceNumber.