{"id":95,"date":"2021-07-21T15:25:23","date_gmt":"2021-07-21T15:25:23","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=95"},"modified":"2021-07-21T15:25:23","modified_gmt":"2021-07-21T15:25:23","slug":"request-variables-pushed-to-merchants-serverresulturl","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/hosted-payment-form\/request-variables-pushed-to-merchants-serverresulturl\/","title":{"rendered":"Request Variables Pushed To Merchants ServerResultURL"},"content":{"rendered":"

Below are the variable outputs from the gateway during the multiple stages in the SERVER Result Delivery Method. Also, the required hashing variables are listed separately, and in what order to use them during variable hashing. As explained above, this will help identify variable tampering.<\/p>\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Variable<\/strong><\/span> Name<\/strong><\/span><\/span><\/td>\nData<\/strong><\/span> Type<\/strong><\/span><\/span><\/td>\nMax<\/strong><\/span> Length<\/strong><\/span><\/span><\/td>\nComments<\/strong><\/span><\/span><\/td>\n<\/tr>\n
HashDigest<\/span><\/span><\/td>\nA<\/span><\/span><\/td>\n\n

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

\n

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

MerchantID<\/span><\/span><\/td>\nA<\/span><\/span><\/td>\n\n

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

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

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

This<\/span> indicates<\/span> the<\/span> status<\/span> of<\/span> the<\/span> transaction:<\/span><\/span><\/p>\n

 <\/p>\n

    \n
  • \n

    0:<\/span> transaction successful<\/span><\/span><\/p>\n<\/li>\n

  • \n

    4:<\/span> card<\/span> referred<\/span><\/span><\/p>\n<\/li>\n

  • \n

    5:<\/span> card<\/span> declined<\/span><\/span><\/p>\n<\/li>\n

  • \n

    20:<\/span> duplicate<\/span> transaction<\/span><\/span><\/p>\n<\/li>\n

  • \n

    30:<\/span> exception<\/span><\/span><\/p>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n

Message<\/span><\/span><\/td>\nA<\/span><\/span><\/td>\n\n

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

This<\/span> gives<\/span> a more<\/span> detailed<\/span> description<\/span> of<\/span> the<\/span> status<\/span> of<\/span> the<\/span><\/span><\/p>\n

transaction<\/span><\/span><\/td>\n<\/tr>\n

PreviousStatusCode<\/span><\/span><\/td>\nN<\/span><\/span><\/td>\n\n

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

If<\/span> thetransaction<\/span> wasdeemed<\/span> tobea<\/span> duplicatetransaction,<\/span> this<\/span> indicates<\/span> the<\/span> status<\/span> of<\/span> the previous<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
PreviousMessage<\/span><\/span><\/td>\nA<\/span><\/span><\/td>\n\n

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

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

transaction<\/span><\/span><\/td>\n<\/tr>\n

CrossReference<\/span><\/span><\/td>\nA<\/span><\/span><\/td>\n\n

24<\/span><\/span><\/p>\n<\/td>\n

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

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

\n

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

If<\/span> requested<\/span> (input<\/span> variable<\/span> “EchoAVSCheckResult<\/span><\/span><\/p>\n

= true”) this gives the results of the address<\/span> numeric<\/span> check<\/span> \u2013<\/span> will<\/span> be<\/span> PASSED,<\/span> FAILED,<\/span> PARTIAL,<\/span> NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n

PostCodeCheckResult<\/span><\/span><\/td>\n\n

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

\n

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

If<\/span> requested<\/span> (input<\/span> variable<\/span> “EchoAVSCheckResult<\/span><\/span><\/p>\n

= true”) this gives the results of the post code<\/span> check \u2013 will be PASSED, FAILED, PARTIAL,<\/span> NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n

CV2CheckResult<\/span><\/span><\/td>\n\n

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

\n

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

If<\/span> requested<\/span> (input<\/span> variable<\/span> “EchoCV2CheckResult<\/span><\/span><\/p>\n

= true”) this gives the results of the CV2 check \u2013<\/span> will be PASSED, FAILED, NOT_CHECKED or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n

ThreeDSecureAuthenticationCheckResult<\/span><\/span><\/td>\n\n

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

\n

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

If requested (input variable<\/span> “EchoThreeDSecureAuthenticationCheckResult =<\/span> true”) this gives the results of the 3D Secure<\/span> check<\/span> –<\/span> will<\/span> be<\/span> PASSED,<\/span> FAILED, NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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
FraudProtectionCheckResult<\/span><\/span><\/td>\n\n

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

\n

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

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

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

\n

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

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

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

\n

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

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

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

\n

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

If<\/span> requested<\/span> (input<\/span> variable<\/span> “EchoCardType<\/span> =<\/span><\/span><\/p>\n

true”)<\/span> this<\/span> gives<\/span> the<\/span> card<\/span> issuer<\/span> (if<\/span> known)<\/span><\/span><\/td>\n<\/tr>\n

CardIssuerCountryCode<\/span><\/span><\/td>\n\n

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

\n

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

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

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

\n

6<\/span><\/span><\/p>\n<\/td>\n

If requested (input variable<\/span> “EchoCardNumberFirstSix = true”) this gives the<\/span> first<\/span> 6<\/span> digits<\/span> of<\/span> the<\/span> card<\/span> number<\/span> of<\/span> the<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
CardNumberLastFour<\/span><\/span><\/td>\n\n

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

\n

4<\/span><\/span><\/p>\n<\/td>\n

If requested (input variable<\/span> “EchoCardNumberLastFour =<\/span> true”) this<\/span> gives the<\/span> last<\/span> 4<\/span> digits<\/span> of<\/span> the<\/span> card<\/span> number<\/span> of<\/span> the<\/span><\/span><\/p>\n

transaction<\/span><\/span><\/td>\n<\/tr>\n

CardExpiryDate<\/span><\/span><\/td>\n\n

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

\n

5<\/span><\/span><\/p>\n<\/td>\n

If<\/span> requested<\/span> (input<\/span> variable<\/span> “EchoCardExpiryDate<\/span><\/span><\/p>\n

= true”) this gives the expiry date of the card of<\/span> the<\/span> transaction. Will<\/span> be<\/span> in<\/span> the<\/span> form<\/span> “MM\/YY”<\/span> e.g.<\/span> “12\/14”<\/span><\/span><\/td>\n<\/tr>\n

Amount<\/span><\/span><\/td>\nN<\/span><\/span><\/td>\n\n

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

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

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

\n

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

If<\/span> requested<\/span> (input<\/span> variable<\/span><\/span><\/p>\n

“EchoDonationAmount<\/span> =<\/span> true”)<\/span> this<\/span> gives<\/span> the<\/span> donation<\/span> amount<\/span> in<\/span> minor<\/span> currency<\/span><\/span><\/td>\n<\/tr>\n

CurrencyCode<\/span><\/span><\/td>\nN<\/span><\/span><\/td>\n\n

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

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

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

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

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

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

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

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

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

The<\/span> order<\/span> description<\/span> of<\/span> the<\/span> transaction<\/span> that<\/span> was<\/span> processed.<\/span> Note:<\/span> make<\/span> surethatspecialcharactersintheOrderDescriptionare<\/span><\/span><\/p>\n

properly<\/span> escaped,<\/span> otherwise<\/span> the<\/span> hash digest<\/span> will<\/span> not<\/span> match<\/span><\/span><\/td>\n<\/tr>\n

CustomerName<\/span><\/span><\/td>\nA<\/span><\/span><\/td>\n\n

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

The<\/span> name<\/span> of<\/span> the<\/span> customer<\/span> as<\/span> it<\/span> was<\/span> submitted<\/span> to the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
Address1<\/span><\/span><\/td>\nA<\/span><\/span><\/td>\n\n

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

100<\/span><\/span><\/td>\nThe<\/span> customer’s<\/span> email<\/span> address<\/span> as<\/span> it<\/span> was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PhoneNumber<\/span><\/span><\/td>\n\n

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

30<\/span><\/span><\/td>\nThe<\/span> customer’s<\/span> phone<\/span> number<\/span> as<\/span> it<\/span> was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
DateOfBirth<\/span><\/span><\/td>\n\n

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

10<\/span><\/span><\/td>\nThe<\/span> customer’s<\/span> date<\/span> of<\/span> birth<\/span> as<\/span> it was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountName<\/span><\/span><\/td>\n\n

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

100<\/span><\/span><\/td>\nThe name of the primary account holder as it was submitted to the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountNumb<\/span> er<\/span><\/span><\/td>\n\n

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

50<\/span><\/span><\/td>\nThe account number of the primary account as it was submitted to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountDateO<\/span> fBirth<\/span><\/span><\/td>\n\n

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

10<\/span><\/span><\/td>\nThe<\/span> date<\/span> of<\/span> birth<\/span> of<\/span> the<\/span> primary account<\/span> holder<\/span> as<\/span> it<\/span> was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountPostCo<\/span> de<\/span><\/span><\/td>\n\n

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

50<\/span><\/span><\/td>\nThe post code of the primary account holder as it was submitted to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

Below are the variable outputs from the gateway during the multiple stages in the SERVER Result Delivery Method. Also, the required hashing variables are listed separately, and in what order to use them during variable hashing. As explained above, this will help identify variable tampering. Variable Name Data Type Max Length Comments HashDigest A –…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[4,31],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/95"}],"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=95"}],"version-history":[{"count":1,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/95\/revisions"}],"predecessor-version":[{"id":96,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/95\/revisions\/96"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=95"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=95"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=95"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}