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

Below is the order that the variables should be listed when creating the hash digest to check against the one in submitted in the form. The string to be hashed must be comprised of the variables listed in the order below in standard URL format (i.e. listed in name\/value pairs, delimited with an ampersand character e.g. “variable1=value&variable2=value&variable3=value”). The variable names and values are case-sensitive and the values should be represented EXACTLY as they appear in the form (NON-URL ENCODED). This hash must be checked against the one submitted in the form, and it should be exactly the same as the hash digest created by us. Any differences should be treated with EXTREME caution, as this indicates that the variables in the form have been tampered with.<\/p>\n

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

Mandatory<\/strong><\/span><\/span><\/p>\n<\/td>\n

Comments<\/strong><\/span><\/span><\/td>\n<\/tr>\n
PreSharedKey<\/span><\/span><\/td>\nSee<\/span> comments<\/span><\/span><\/td>\nThe<\/span> pre<\/span> shared<\/span> key<\/span> should<\/span> ONLY<\/span> be<\/span> included<\/span> in<\/span> the<\/span> hash<\/span> digest<\/span> if<\/span> the<\/span> chosen<\/span> hash method is standard (i.e. not HMAC) MD5 or SHA1. If the chosen hash<\/span> method is either HMACMD5 or HMACSHA1, then the pre shared key is used<\/span> as part of the hash generation so should be ENTIRELY omitted from the<\/span> string<\/span> to<\/span> be<\/span> hashed<\/span><\/span><\/td>\n<\/tr>\n
MerchantID<\/span><\/span><\/td>\n\n

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

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

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

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

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

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

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

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

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

Must be included as “PreviousStatusCode=” if an empty variable in the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
PreviousMessage<\/span><\/span><\/td>\n\n

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

Must be included as “PreviousMessage=” if an empty variable in the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
CrossReference<\/span><\/span><\/td>\n\n

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

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

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

Must be included as<\/span> “AddressNumericCheckResult=” if an empty<\/span> variable in the form. NOT included in the hash if<\/span> not present in the form (only for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PostCodeCheckResult<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “PostCodeCheckResult=”<\/span> if<\/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
 <\/td>\n <\/td>\n\n

an empty variable in the form. NOT included in the<\/span> hash<\/span> if<\/span> not<\/span> present<\/span> in<\/span> the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

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

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

Must<\/span> be<\/span> included<\/span> as<\/span> “CV2CheckResult=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span> form.<\/span> NOT<\/span> included<\/span> in<\/span> the<\/span> hash<\/span> if<\/span> not<\/span> present in the form (only for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
ThreeDSecureAuthenticationCheckResult<\/span><\/span><\/td>\n\n

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

Must be included as<\/span> “ThreeDSecureAuthenticationCheckResult=”<\/span> if<\/span> an<\/span> empty variable in the form. NOT included in the<\/span> hash if not present in the form (only for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
FraudProtectionCheckResult<\/span><\/span><\/td>\n\n

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

Must be included as<\/span> “FraudProtectionCheckResult=” if an empty<\/span> variable in the form. NOT included in the hash if<\/span> not present in the form (only for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CardType<\/span><\/span><\/td>\n\n

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

Must be included as<\/span> “FraudProtectionCheckResult=” if an empty<\/span> variable in the form. NOT included in the hash if<\/span> not<\/span> present<\/span> in the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span><\/span><\/p>\n

compatibility)<\/span><\/span><\/td>\n<\/tr>\n

CardClass<\/span><\/span><\/td>\n\n

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

Must be included as “CardClass=” if an empty<\/span> variable in the form. NOT included in the hash if<\/span> not present in the form (only for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CardIssuer<\/span><\/span><\/td>\n\n

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

Must be included as “CardIssuer=” if an empty<\/span> variable in the form. NOT included in the hash if<\/span> not present in the form (only for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CardIssuerCountryCode<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “CardIssuerCountryCode=”<\/span> if an<\/span> empty variable in the form. NOT included in the<\/span> hash if not present in the form (only for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CardNumberFirstSix<\/span><\/span><\/td>\n\n

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

Must be included as “CardNumberFirstSix=” if an<\/span> empty variable in the form. NOT included in the<\/span> hash<\/span> if<\/span> not<\/span> present<\/span> in<\/span> the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CardNumberLastFour<\/span><\/span><\/td>\n\n

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

Must be included as “CardNumberLastFour=” if<\/span> an empty variable in the form. NOT included in<\/span> the hash if not present in the form (only for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CardExpiryDate<\/span><\/span><\/td>\n\n

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

Must be included as “CardExpiryDate=” if an empty<\/span> variable<\/span> in<\/span> the<\/span> form.<\/span> NOT<\/span> included<\/span> in<\/span> the<\/span> hash<\/span> if<\/span> not<\/span> present in the form (only for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
Amount<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\n <\/td>\n<\/tr>\n
DonationAmount<\/span><\/span><\/td>\n\n

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

Must be included as “DonationAmount=” if an<\/span> empty variable in the form. NOT included in the<\/span> hash if not present in the form (only for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CurrencyCode<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\n <\/td>\n<\/tr>\n
OrderID<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nNote:<\/span> make<\/span> sure<\/span> that<\/span> special<\/span> characters<\/span> in<\/span> the<\/span> OrderID<\/span> are<\/span> properly<\/span> escaped, otherwise<\/span> the<\/span> hash<\/span> digest<\/span> will<\/span> not match<\/span><\/span><\/td>\n<\/tr>\n
TransactionType<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\n <\/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
TransactionDateTime<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\n <\/td>\n<\/tr>\n
OrderDescription<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust be included as “OrderDescription=” if an empty variable in the<\/span> form.<\/span> Note:<\/span> make<\/span> sure<\/span> that<\/span> special<\/span> characters<\/span> in<\/span> the<\/span> OrderDescription<\/span> are<\/span> properly escaped,<\/span> otherwise<\/span> the<\/span> hash<\/span> digest will<\/span> not<\/span> match<\/span><\/span><\/td>\n<\/tr>\n
CustomerName<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “CustomerName=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span><\/span><\/p>\n

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

Address1<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “Address1=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
Address2<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “Address2=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
Address3<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “Address3=”<\/span> if<\/span> an<\/span> empty variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
Address4<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “Address4=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
City<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “City=”<\/span> if an empty<\/span> variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
State<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “State=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
PostCode<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “PostCode=”<\/span> if<\/span> an empty<\/span> variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
CountryCode<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMustbeincludedas”CountryCode=”ifanemptyvariableintheform<\/span><\/span><\/td>\n<\/tr>\n
EmailAddress<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust be included as “EmailAddress=” if an empty variable in the form.<\/span> NOT<\/span> included<\/span> in<\/span> the<\/span> hash<\/span> if<\/span> not<\/span> present<\/span> in<\/span> the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PhoneNumber<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\n\n

Must be included as “PhoneNumber=” if an empty variable in the form.<\/span> NOT<\/span> included<\/span> in<\/span> the<\/span> hash<\/span> if<\/span> not<\/span> present<\/span> in<\/span> the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

DateOfBirth<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust be included as “DateOfBirth=” if an empty variable in the form.<\/span> NOT<\/span> included<\/span> in<\/span> the<\/span> hash<\/span> if<\/span> not<\/span> present<\/span> in<\/span> the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountName<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “PrimaryAccountName=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span> form. NOT included in the hash if not present in the form (only for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountNumb<\/span> er<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “PrimaryAccountNumber=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the form. NOT included in the hash if not present in the form (only for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountDateO<\/span> fBirth<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust be included as “PrimaryAccountDateOfBirth=” if an empty<\/span> variable in the form. NOT included in the hash if not present in the<\/span> form<\/span> (only<\/span> for backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountPostCo<\/span> de<\/span><\/span><\/td>\nYes<\/span><\/span><\/td>\nMust<\/span> be<\/span> included<\/span> as<\/span> “PrimaryAccountPostCode=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the form. NOT included in the hash if not present in the form (only for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n

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

Below is the order that the variables should be listed when creating the hash digest to check against the one in submitted in the form. The string to be hashed must be comprised of the variables listed in the order below in standard URL format (i.e. listed in name\/value pairs, delimited with an ampersand character…<\/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\/97"}],"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=97"}],"version-history":[{"count":1,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/97\/revisions"}],"predecessor-version":[{"id":98,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/97\/revisions\/98"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=97"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=97"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=97"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}