{"id":85,"date":"2021-07-21T15:10:20","date_gmt":"2021-07-21T15:10:20","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=85"},"modified":"2022-07-21T11:39:52","modified_gmt":"2022-07-21T11:39:52","slug":"incoming-hash-digest","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/hosted-payment-form\/incoming-hash-digest\/","title":{"rendered":"Incoming Hash Digest | Hash Data"},"content":{"rendered":"

Below is the order that the variables should be listed when creating the hash digest. 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
Variable<\/strong><\/span> Name<\/strong><\/span><\/span><\/td>\nMandatory<\/strong><\/span><\/span><\/p>\n

or<\/strong><\/span> Always<\/strong><\/span> Present<\/strong><\/span><\/span><\/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<\/span> method<\/span> is<\/span> standard<\/span> (i.e. not HMAC) MD5 or SHA1. If the chosen hash<\/span> method is either HMACMD5 or HMACSHA1, then<\/span> the pre shared key is used as part of the hash<\/span> generation so should be ENTIRELY omitted from<\/span> the string to be hashed – if it is present in these<\/span> cases<\/span> (even<\/span> as<\/span> an<\/span> empty<\/span> string),<\/span> then<\/span> an error<\/span> will<\/span><\/span><\/p>\n

be<\/span> thrown<\/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
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
Amount<\/span><\/span><\/td>\n\n

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

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

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

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

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

\n

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

EchoCV2CheckResult<\/span><\/span><\/td>\n\n

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

\n

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

EchoThreeDSecureAuthenticationCheckResult<\/span><\/span><\/td>\n\n

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

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

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

EchoFraudProtectionCheckResult<\/span><\/span><\/td>\n\n

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

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

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

\n

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

EchoCardNumberFirstSix<\/span><\/span><\/td>\n\n

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

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

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

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

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

EchoCardExpiryDate<\/span><\/span><\/td>\n\n

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

\n

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

EchoDonationAmount<\/span><\/span><\/td>\n\n

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

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

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

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

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

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

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

Must be included as<\/span> “ThreeDSecureOverridePolicy=”<\/span> if<\/span> empty<\/span> in<\/span> the<\/span> form.<\/span> NOT<\/span> included<\/span> in<\/span> the<\/span> hash<\/span> if<\/span> not<\/span> present<\/span><\/span><\/p>\n

in<\/span> the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span> compatibility)<\/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
OrderID<\/span><\/span><\/td>\n\n

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

Note:<\/span> make sure<\/span> that<\/span> special<\/span> characters<\/span> in<\/span> the<\/span><\/span><\/p>\n

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

TransactionType<\/span><\/span><\/td>\n\n

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

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

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

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

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

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

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

Must<\/span> be<\/span> included<\/span> as<\/span> “OrderDescription=”<\/span> if<\/span> not<\/span> submitted or empty in the form. Note: make<\/span> sure that special characters in the<\/span> OrderDescription<\/span> are<\/span> properly<\/span> escaped,<\/span><\/span><\/p>\n

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

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

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

Mustbeincludedas”CustomerName=” ifnot<\/span> submitted<\/span> or<\/span> empty<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
Address1<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “Address1=”<\/span> if<\/span> not<\/span><\/span><\/p>\n

submitted<\/span> or<\/span> empty<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n

Address2<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “Address2=”<\/span> if<\/span> not<\/span><\/span><\/p>\n

submitted or<\/span> empty in the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n

Address3<\/span><\/span><\/td>\n\n

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

Must be included as “Address3=” if not<\/span> submitted<\/span> or<\/span> empty<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
Address4<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “Address4=”<\/span> if<\/span> not<\/span><\/span><\/p>\n

submitted<\/span> or<\/span> empty<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n

City<\/span><\/span><\/td>\n\n

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

Mustbeincludedas”City=”<\/span> if<\/span> notsubmittedor<\/span> empty in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
State<\/span><\/span><\/td>\n\n

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

Must<\/span> beincluded<\/span> as”State=”<\/span> if<\/span> not<\/span> submitted<\/span> or<\/span> empty<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
PostCode<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “PostCode=”<\/span> if<\/span> not<\/span><\/span><\/p>\n

submitted<\/span> or<\/span> empty<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n

CountryCode<\/span><\/span><\/td>\n\n

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

Must be included as “CountryCode=” if not<\/span> submitted<\/span> or<\/span> empty<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n
EmailAddress<\/span><\/span><\/td>\n\n

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

\n

Must be included as “EmailAddress=” if empty in<\/span> the<\/span> 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

PhoneNumber<\/span><\/span><\/td>\n\n

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

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

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

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

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

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

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

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

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

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

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

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

compatibility)<\/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
Address1Mandatory<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “Address1Mandatory=”<\/span> if<\/span> emptyintheform.NOTincludedinthehashif<\/span><\/span><\/p>\n

not<\/span> present<\/span> in<\/span> the<\/span> form<\/span> (only<\/span> for<\/span> backwards<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n

CityMandatory<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “CityMandatory=”<\/span> if<\/span> empty<\/span> in the form. NOT included in the hash if not<\/span> present in the form (only for backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PostCodeMandatory<\/span><\/span><\/td>\n\n

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

\n

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

StateMandatory<\/span><\/span><\/td>\n\n

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

Must be included as “StateMandatory=” if<\/span> empty in the form. NOT included in the hash if<\/span> not present in the form (only for backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
CountryMandatory<\/span><\/span><\/td>\n\n

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

Must be included as “CountryMandatory=”<\/span> empty in the form. NOT included in the hash if<\/span> not present in the form (only for backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
ResultDeliveryMethod<\/span><\/span><\/td>\n\n

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

Pleaseseethe<\/span> Result<\/span> Delivery<\/span> Methodsection.<\/span><\/span><\/td>\n<\/tr>\n
ServerResultURL<\/span><\/span><\/td>\n\n

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

Must be included as “ServerResultURL=” if<\/span> empty in the form. NOT included in the hash if<\/span> not present in the form (only for backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PaymentFormDisplaysResult<\/span><\/span><\/td>\n\n

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

Must be included as<\/span> “PaymentFormDisplaysResult=” if empty in the<\/span> form. NOT included in the hash if not present in<\/span> the<\/span> form<\/span> (only for<\/span> backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountName<\/span><\/span><\/td>\n\n

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

Must be included as ” PrimaryAccountName=” if<\/span> empty<\/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 backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountNumber<\/span><\/span><\/td>\n\n

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

Must be included as “<\/span> PrimaryAccountNumber=” if empty in the form.<\/span> NOT included in the hash if not present in the<\/span> form<\/span> (only<\/span> for backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountName<\/span><\/span><\/td>\n\n

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

Must be included as “PrimaryAccountName=” if<\/span> empty<\/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 backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountNumber<\/span><\/span><\/td>\n\n

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

Must be included as “PrimaryAccountNumber=”<\/span> if empty in the form. NOT included in the hash if<\/span> not present in the form (only for backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountDateOfBirth<\/span><\/span><\/td>\n\n

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

Must be included as “<\/span> PrimaryAccountDateOfBirth=” if empty in the<\/span> form. NOT included in the hash if not present in<\/span> the<\/span> form<\/span> (only for<\/span> backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountPostCode<\/span><\/span><\/td>\n\n

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

Must be included as “<\/span> PrimaryAccountPostCode=” if empty in the<\/span> form. NOT included in the hash if not present in<\/span> the<\/span> form<\/span> (only for<\/span> backward<\/span> compatibility)<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/h1>\n

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

Below is the order that the variables should be listed when creating the hash digest. 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…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[4,32],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/85"}],"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=85"}],"version-history":[{"count":3,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/85\/revisions"}],"predecessor-version":[{"id":634,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/85\/revisions\/634"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=85"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=85"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=85"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}