|
Variable Name |
Mandatory or Always Present |
Comments |
|
PreSharedKey |
See comments |
The pre shared key should ONLY be included in the hash digest if the chosen hash method is standard (i.e. not HMAC) MD5 or SHA1. If the chosen hash method is either HMACMD5 or HMACSHA1, then the pre shared key is used as part of the hash generation so should be ENTIRELY omitted from the string to be hashed – if it is present in these cases (even as an empty string), then an error will be thrown |
|
MerchantID |
Yes |
|
|
Password |
Yes |
|
|
StatusCode |
Yes |
|
|
Message |
Yes |
|
|
PreviousStatusCode |
Yes |
Must be included as “PreviousStatusCode=” if an empty variable in the form |
|
PreviousMessage |
Yes |
Must be included as “PreviousMessage=” if an empty variable in the form |
|
CrossReference |
Yes |
|
|
AddressNumericCheckResult |
Yes |
Must be included as “AddressNumericCheckResult=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
PostCodeCheckResult |
Yes |
Must be included as “PostCodeCheckResult=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
CV2CheckResult |
Yes |
Must be included as “CV2CheckResult=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
ThreeDSecureAuthenticationCheckResult |
Yes |
Must be included as “ThreeDSecureAuthenticationCheckResult=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
FraudProtectionCheckResult |
Yes |
Must be included as “FraudProtectionCheckResult=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
CardType |
Yes |
Must be included as “CardType=” if an empty variable in the form. NOT included in the hash if not |
|
|
|
present in the form (only for backwards compatibility) |
|
CardClass |
Yes |
Must be included as “CardClass=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
CardIssuer |
Yes |
Must be included as “CardIssuer=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
CardIssuerCountryCode |
Yes |
Must be included as “CardIssuerCountryCode=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
Amount |
Yes |
|
|
CurrencyCode |
Yes |
|
|
OrderID |
Yes |
Note: make sure that special characters in the OrderID are properly escaped, otherwise the hash digest will not match |
|
TransactionType |
Yes |
|
|
TransactionDateTime |
Yes |
|
|
OrderDescription |
Yes |
Must be included as “OrderDescription=” if an empty variable in the form. Note: make sure that special characters in the OrderDescription are properly escaped, otherwise the hash digest will not match |
|
Address1 |
Yes |
Must be included as “Address1=” if an empty variable in the form |
|
Address2 |
Yes |
Must be included as “Address2=” if an empty variable in the form |
|
Address3 |
Yes |
Must be included as “Address3=” if an empty variable in the form |
|
Address4 |
Yes |
Must be included as “Address4=” if an empty variable in the form |
|
City |
Yes |
Must be included as “City=” if an empty variable in the form |
|
State |
Yes |
Must be included as “State=” if an empty variable in the form |
|
PostCode |
Yes |
Must be included as “PostCode=” if an empty variable in the form |
|
CountryCode |
Yes |
Must be included as “CountryCode=” if an empty variable in the form |
|
EmailAddress |
Yes |
Must be included as “EmailAddress=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
|
PhoneNumber |
Yes |
Must be included as “PhoneNumber=” if an empty variable in the form. NOT included in the hash if not present in the form (only for backwards compatibility) |
