Skip to main content

Request Fields

Initial Request (Hosted and Direct Integration)​

These fields should be sent in addition to the Basic Request Fields excluding any card details.

Field NameMandatory?Description
Field NameMandatory?Description
paymentMethodYes[1]1Must be the value ‘qidigital’ in lower case only.
checkoutRedirectURLYes[2]2URL on Merchant’s server to return to when the Qi Digital Checkout is closed.

Continuation Request (Direct Integration)​

These fields may be sent alone[3].

Field NameMandatory?Description
checkoutRefYesUnique reference required to continue the transaction on completion of the Qi Digital Checkout.
checkoutResponseYesRecord containing any GET and or POST data received by the checkoutRedirectURL page.

[3] It is only necessary to send the checkoutRef and the checkoutResponse in the continuation request because the checkoutRef will identify the Merchant Account and initial request. You can send any of the normal request fields to modify or supplement the initial request. The message need not be signed but it is highly recommended that you do if not sending over a secure server to server connection. The checkoutRedirectURL and checkoutOptions fields sent in the initial request cannot be modified and any sent in the second request must match those used in the first request, or the second request will fail with a responseCode of 64442 (REQUEST MISMATCH).

Footnotes​

  1. Optional in Hosted Integration ↩

  2. Not required for Hosted Integration. ↩