Below is a description of the variables that comprise the input API of the payment form. This request may yield either a 3D Secure “Authentication Required” response or a “Payment Complete” response.
|
Input Field Name |
Data Type |
Max Length |
Mandatory or Always Present |
Comments |
|
HashDigest |
A |
– |
Yes |
A hashed string that contains all the variables passed and also data that is not passed but is known to both sides – namely the PreSharedKey and the gateway account password. (see section below) |
|
MerchantID |
A |
15 |
Yes |
The merchant ID that corresponds to the gateway account the transaction will be run through. NOTE: If this variable is not present, then the skinning of the payment form will not happen |
|
Amount |
N |
13 |
Yes |
The transaction amount in minor currency – e.g. for £10.00, it must be submitted as 1000 |
|
CurrencyCode |
N |
3 |
Yes |
The currency of the transaction. ISO 4217 e.g. GBP: 826 |
|
EchoAVSCheckResult |
B |
true/false |
Yes |
Instructs the payment form to include the AVS check result of the transaction in the output variables |
|
EchoCV2CheckResult |
B |
true/false |
Yes |
Instructs the payment form to include the CV2 check result of the transaction in the output variables |
|
EchoThreeDSecureAuthenticationCheckResult |
B |
true/false |
Yes |
Instructs the payment form to include the 3D Secure check result of the transaction in the output variables |
|
EchoFraudProtectionCheckResult |
B |
true/false |
Yes |
Instructs the payment form to include the Fraud protection check result of the transaction |
|
|
|
|
|
in the output variables |
|
EchoCardType |
B |
true/false |
Yes |
Instructs the payment form to include the card type of the transaction in the output variables |
|
AVSOverridePolicy |
A |
4 |
No |
Sets the override AVS checking policy for this transaction |
|
CV2OverridePolicy |
A |
2 |
No |
Sets the CV2 checking policy for this transaction |
|
ThreeDSecureOverridePolicy |
B |
true/false |
No |
Instructs the payment form to enable/disable the 3D Secure checking for this transaction (where possible) |
|
OrderID |
A |
50 |
Yes |
A merchant side ID for the order – primarily used to for determining duplicate transactions. Note: make sure that special characters in the OrderID are properly escaped, otherwise the hash digest will not match |
|
TransactionType |
– |
– |
Yes |
Must be either SALE or PREAUTH |
|
TransactionDateTime |
DT |
– |
Yes |
The date & time (as seen by the merchant’s server) of the transaction. Needs to be in the form “YYYY- MM-DD HH:MM:SS +00:00”, with the time in 24 hour format, where 00:00 is the offset from UTC – e.g. “2008-12-01 14:12:00 +01:00” |
|
CallbackURL |
A |
– |
Yes |
The URL of the page on the merchant’s site that the results of the transaction will be posted back to (see section below) |
|
OrderDescription |
A |
256 |
No |
A description for the order. Note: make sure that special characters in the OrderDescription are properly escaped, otherwise the hash digest will not match |
|
Address1 |
A |
100 |
No |
Customer’s billing address line 1 |
|
Address2 |
A |
50 |
No |
Customer’s billing |
|
|
|
|
|
address line 2 |
|
Address3 |
A |
50 |
No |
Customer’s billing address line 3 |
|
Address4 |
A |
50 |
No |
Customer’s billing address line 4 |
|
City |
A |
50 |
No |
Customer’s billing address city |
|
State |
A |
50 |
No |
Customer’s billing address state |
|
PostCode |
A |
50 |
No |
Customer’s billing address post code |
|
CountryCode |
N |
3 |
No |
Customer’s billing country code. ISO 3166- 1 e.g. United Kingdom: 826 |
|
EmailAddress |
A |
100 |
No |
Customer’s email address |
|
PhoneNumber |
A |
30 |
No |
Customer’s phone number |
|
CardName |
A |
100 |
Yes |
The cardholder’s name as it appears on the front of the card |
|
CardNumber |
A |
19 |
Yes |
The full card number as it appears on the front of the card |
|
ExpiryDateMonth |
A |
2 |
Yes |
The first 2 digits from the card’s expiry date representing the month part of the expiry date e.g. 02/12 where 02 is the card’s expiry month |
|
ExpiryDateYear |
A |
2 |
Yes |
The last 2 digits from the card’s expiry date representing the year part of the expiry date e.g. 02/12 where 12 is the card’s expiry year of 2012 |
|
StartDateMonth |
A |
2 |
No |
The first 2 digits from the card’s start date representing the month part of the start date e.g. 01/09 where 01 is the card’s start month |
|
StartDateYear |
A |
2 |
No |
The last 2 digits from card’s start date representing the year part of the start date e.g. 01/09 where 09 is the card’s start year of 2009 |
|
IssueNumber |
A |
2 |
No |
The card’s issue number as it appears on the front on the card |
|
CV2 |
N |
3 |
No |
The card’s CV2 number |