{"id":188,"date":"2021-07-21T17:48:52","date_gmt":"2021-07-21T17:48:52","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=188"},"modified":"2021-07-21T17:55:51","modified_gmt":"2021-07-21T17:55:51","slug":"output-variables-2","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/transparent-redirect\/payment-complete\/output-variables-2\/","title":{"rendered":"Output Variables"},"content":{"rendered":"

Below is a description of the variables will be posted to the merchant’s CallbackURL. These comprise the “Payment Complete” output API of the payment form.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Variable Name<\/strong><\/p>\n<\/td>\n

\n

Data Type<\/strong><\/p>\n<\/td>\n

\n

Max Length<\/strong><\/p>\n<\/td>\n

\n

Comments<\/strong><\/p>\n<\/td>\n<\/tr>\n

\n

HashDigest<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

A hashed string that contains all the variables passed and also data that is not passed but is known to both sides – namely the PreSharedKey and the gateway account password. (see section below)<\/p>\n<\/td>\n<\/tr>\n

\n

MerchantID<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

15<\/p>\n<\/td>\n

\n

The merchant ID that was used to process the transaction<\/p>\n<\/td>\n<\/tr>\n

\n

StatusCode<\/p>\n<\/td>\n

\n

N<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

This indicates the status of the transaction:
0: transaction successful
5: card referred
5: card declined
20: duplicate transaction
30: exception<\/p>\n<\/td>\n<\/tr>\n

\n

Message<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

512<\/p>\n<\/td>\n

\n

This gives a more detailed description of the status of the transaction<\/p>\n<\/td>\n<\/tr>\n

\n

PreviousStatusCode<\/p>\n<\/td>\n

\n

N<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If the transaction was deemed to be a duplicate transaction, this indicates the status of the previous transaction<\/p>\n<\/td>\n<\/tr>\n

\n

PreviousMessage<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

512<\/p>\n<\/td>\n

\n

If the transaction was deemed to be a duplicate transaction, this gives a more detailed description of the status of the previous transaction<\/p>\n<\/td>\n<\/tr>\n

\n

CrossReference<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

25<\/p>\n<\/td>\n

\n

This is the unique cross reference for this transaction. If the transaction was determined to be a duplicate transaction, this value will hold the cross reference of the previous transaction, which this transaction was deemed a duplicate of<\/p>\n<\/td>\n<\/tr>\n

\n

AddressNumericCheckResult<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If requested (input variable “EchoAVSCheckResult = true”) this gives the results of the address numeric check – will be PASSED, FAILED, PARTIAL, NOT_CHECKED or UNKNOWN<\/p>\n<\/td>\n<\/tr>\n

\n

PostCodeCheckResult<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If requested (input variable “EchoAVSCheckResult = true”) this gives the results of the post code check – will be PASSED, FAILED, PARTIAL, NOT_CHECKED or UNKNOWN<\/p>\n<\/td>\n<\/tr>\n

\n

CV2CheckResult<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If requested (input variable “EchoCV2CheckResult = true”) this gives the results of the CV2check – will be PASSED, FAILED, NOT_CHECKED or UNKNOWN<\/p>\n<\/td>\n<\/tr>\n

\n

ThreeDSecureAuthenticationCheckResult<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If 3D Secure policy is enabled (input variable “ThreeDSecureOverridePolicy = true”) this will give the results of the 3D Secure check<\/p>\n<\/td>\n<\/tr>\n

\n

FraudProtectionCheckResult<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If requested (input variable “EchoFraudProtectionCheckResult = true”) this gives the results of the Fraud protection check – will be PASSED, FAILED, CHALLENGE or ERROR<\/p>\n<\/td>\n<\/tr>\n

\n

CardType<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If requested (input variable “EchoCardType = true”) this gives the card type of the transaction<\/p>\n<\/td>\n<\/tr>\n

\n

CardClass<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If requested (input variable “EchoCardType = true”) this gives the card class of the transaction<\/p>\n<\/td>\n<\/tr>\n

\n

CardIssuer<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

If requested (input variable “EchoCardType = true”) this gives the card issuer (if known)<\/p>\n<\/td>\n<\/tr>\n

\n

CardIssuerCountryCode<\/p>\n<\/td>\n

\n

N<\/p>\n<\/td>\n

\n

3<\/p>\n<\/td>\n

\n

If requested (input variable “EchoCardType = true”) this gives the 3 digit code of the country the card was issued in (if known)<\/p>\n<\/td>\n<\/tr>\n

\n

Amount<\/p>\n<\/td>\n

\n

N<\/p>\n<\/td>\n

\n

13<\/p>\n<\/td>\n

\n

The amount, in minor currency, of the transaction that was processed<\/p>\n<\/td>\n<\/tr>\n

\n

CurrencyCode<\/p>\n<\/td>\n

\n

N<\/p>\n<\/td>\n

\n

3<\/p>\n<\/td>\n

\n

The currency code of the transaction that was processed. ISO 4217 e.g. GBP: 826<\/p>\n<\/td>\n<\/tr>\n

\n

OrderID<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

50<\/p>\n<\/td>\n

\n

The order ID of the transaction that was processed. Note: make sure that special characters in the OrderID are properly escaped, otherwise the hash digest will not match<\/p>\n<\/td>\n<\/tr>\n

\n

TransactionType<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

The transaction type of the transaction that was processed. Will be either SALE or PREAUTH<\/p>\n<\/td>\n<\/tr>\n

\n

TransactionDateTime<\/p>\n<\/td>\n

\n

DT<\/p>\n<\/td>\n

\n

–<\/p>\n<\/td>\n

\n

The date & time (as seen by the gateway server) of the transaction. Will be in the form “YYYY- MM-DD HH:MM:SS +OO:OO”, with the time in 24 hour format, where OO:OO is the offset from UTC – e.g. “2008-12-01 14:12:00 +01:00”<\/p>\n<\/td>\n<\/tr>\n

\n

OrderDescription<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

256<\/p>\n<\/td>\n

\n

The order description of the transaction that was processed. Note: make sure that special characters in the OrderDescription are properly escaped, otherwise the hash digest will not match<\/p>\n<\/td>\n<\/tr>\n

\n

Address1<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

100<\/p>\n<\/td>\n

\n

Customer’s billing address line 1 as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

Address2<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

50<\/p>\n<\/td>\n

\n

Customer’s billing address line 2 as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

Address3<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

50<\/p>\n<\/td>\n

\n

Customer’s billing address line 3 as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

Address4<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

50<\/p>\n<\/td>\n

\n

Customer’s billing address line 4 as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

City<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

50<\/p>\n<\/td>\n

\n

Customer’s billing city as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

State<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

50<\/p>\n<\/td>\n

\n

Customer’s billing state as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

PostCode<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

50<\/p>\n<\/td>\n

\n

Customer’s billing post code as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

CountryCode<\/p>\n<\/td>\n

\n

N<\/p>\n<\/td>\n

\n

3<\/p>\n<\/td>\n

\n

Customer’s billing country code as it was submitted to the gateway. ISO 3166-1 e.g. United Kingdom: 826<\/p>\n<\/td>\n<\/tr>\n

\n

EmailAddress<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

100<\/p>\n<\/td>\n

\n

The customer’s email address as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n

\n

PhoneNumber<\/p>\n<\/td>\n

\n

A<\/p>\n<\/td>\n

\n

30<\/p>\n<\/td>\n

\n

The customer’s phone number as it was submitted to the gateway<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

Below is a description of the variables will be posted to the merchant’s CallbackURL. These comprise the “Payment Complete” output API of the payment form. Variable Name Data Type Max Length Comments HashDigest A – A hashed string that contains all the variables passed and also data that is not passed but is known to…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[12],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/188"}],"collection":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/comments?post=188"}],"version-history":[{"count":7,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/188\/revisions"}],"predecessor-version":[{"id":195,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/188\/revisions\/195"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=188"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=188"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}