{"id":91,"date":"2021-07-21T15:19:37","date_gmt":"2021-07-21T15:19:37","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=91"},"modified":"2021-07-21T15:19:37","modified_gmt":"2021-07-21T15:19:37","slug":"outgoing-hash-digest","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/hosted-payment-form\/outgoing-hash-digest\/","title":{"rendered":"Outgoing Hash Digest"},"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\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 if the chosen hash method is standard (i.e. not<\/span> HMAC) MD5 or SHA1. If the chosen hash method is<\/span> either HMACMD5 or HMACSHA1, then the pre shared<\/span> key is used as part of the hash generation so should be<\/span> ENTIRELY<\/span> omitted<\/span> from the string<\/span> to 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<\/span> be<\/span> included as<\/span> “PreviousStatusCode=”<\/span> if<\/span> an<\/span><\/span><\/p>\n

empty variable<\/span> in<\/span> 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<\/span> empty variable<\/span> in<\/span> 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 “AddressNumericCheckResult=”<\/span> if<\/span> an<\/span> empty<\/span> variable<\/span> in<\/span> the<\/span> form.<\/span> NOT<\/span> included<\/span> in<\/span> the<\/span> hash if 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 be included as “PostCodeCheckResult=” if an<\/span> empty 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
CV2CheckResult<\/span><\/span><\/td>\n\n

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

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

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

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

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 “CardType=” if an empty<\/span> variable 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
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 not<\/span> present in the form (only for 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
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 not<\/span> 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 be included as “CardIssuerCountryCode=” if an<\/span> empty 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
CardNumberFirstSix<\/span><\/span><\/td>\n\n

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

Must<\/span> be<\/span> included<\/span> as<\/span> “CardNumberFirstSix=” if an<\/span> empty<\/span> variable 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> 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 an<\/span> empty 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
CardExpiryDate<\/span><\/span><\/td>\n\n

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

Must be included as “CardExpiryDate=” if an empty<\/span> variable 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> compatibility)<\/span><\/span><\/td>\n<\/tr>\n
Amount<\/span><\/span><\/td>\n\n

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

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

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

Must<\/span> be<\/span> included<\/span> as<\/span> “DonationAmount=”<\/span> if<\/span> an<\/span> empty<\/span> variable 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
CurrencyCode<\/span><\/span><\/td>\n\n

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

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

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

Note: make sure that special characters in the<\/span> OrderID are properly escaped, otherwise the 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
OrderDescription<\/span><\/span><\/td>\n\n

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

Must be included as “OrderDescription=” if an<\/span> empty variable in theform. Note: make surethat<\/span> special characters in the OrderDescription are<\/span> properly<\/span> escaped,<\/span> otherwise<\/span> the<\/span> hash<\/span> digest<\/span> will<\/span> not<\/span><\/span><\/p>\n

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

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

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

Mustbeincludedas”CustomerName=”ifanempty<\/span> variable<\/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 be included as “Address1=” if an empty<\/span> variable<\/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> an<\/span> empty<\/span><\/span><\/p>\n

variable<\/span> in<\/span> the<\/span> form<\/span><\/span><\/td>\n<\/tr>\n

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

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

Must<\/span> be<\/span> included<\/span> as<\/span> “Address3=”<\/span> if<\/span> an<\/span> empty<\/span><\/span><\/p>\n

variable<\/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> an<\/span> empty<\/span><\/span><\/p>\n

variable<\/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

Must<\/span> be<\/span> included<\/span> as<\/span> “City=”<\/span> if an empty variable<\/span> 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> 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>\n\n

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

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

variable<\/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<\/span> be<\/span> included<\/span> as<\/span> “CountryCode=”<\/span> if<\/span> an empty<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n\n\n\n\n\n\n\n
 <\/td>\n <\/td>\nvariable<\/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

Must be included as “EmailAddress=” if an empty<\/span> variable 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
PhoneNumber<\/span><\/span><\/td>\n\n

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

Must be included as “PhoneNumber=” if an empty<\/span> variable 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 be included as ” DateOfBirth =” if an empty<\/span> variable 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
PrimaryAccountName<\/span><\/span><\/td>\n\n

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

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

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

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

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

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

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

\n

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

<\/h2>\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\/91"}],"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=91"}],"version-history":[{"count":1,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/91\/revisions"}],"predecessor-version":[{"id":92,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/91\/revisions\/92"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=91"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=91"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=91"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}