Intended Audience – Hosted Payment Form
This document is technical in nature and should be used by your company’s developers to integrate your systems into the…
Simplifying the Integration Process
There are many complexities when dealing with card transactions. If you try and tackle them all at once the task…
Gateway URLs
In this document, payment gateway specific URLs have “paymentprocessor.net” as the domain (For example, https://mms.paymentprocessor.net/). When using these URL’s in…
Hashing Explained
When the Hosted Payment Form solution is implemented, the transaction data must be protected as it is being passed to…
Simple Hashing Example
Here is an example of some transaction variables: MerchantID: YourCo-1234567 Amount: 100.00 Currency Code: 826 Order ID: 12345 These variables…
Notation Explained
The communication between the merchant’s system/customer’s browser, to the gateway Payment Form are POST via HTML form variables. The below…
Data Types
Data Type Description N Numeric – only numbers allowed A Alpha – any printable character is allowed B Boolean…
Result Delivery Methods
Merchant’s systems need to know the result for each completed transaction. The Server Result Methods determine how the transaction results…
POST
Choosing the POST method will deliver the full results via the customer’s browser as a form post back to the…
SERVER
When chosen, the results are PUSHED TO the ServerResultURL on the merchant’s website BEFORE the customer is redirected back to…
SERVER_PULL
When chosen, the results are PULLED FROM the payment form by the merchant’s system AFTER the customer has been redirected…
Required Input Variables
Below is a description of the variables that comprise the input API of the payment form. These variables are delivered…
Incoming Hash Digest | Hash Data
Below is the order that the variables should be listed when creating the hash digest. The string to be hashed…
POST Result Delivery Method
Below are the variable outputs from the gateway during the stages in the POST Result Delivery Method. Also, the required…
Output Variables
Below is a description of the variables which will be posted back to the Merchants CallbackURL. These comprise the output…
Outgoing Hash Digest
Below is the order that the variables should be listed when creating the hash digest to check against the one…
SERVER Result Delivery Method
The results of the transaction are then passed back to the merchant’s system (ServerResultURL). This is a direct layerofcommunication…
Request Variables Pushed To Merchants ServerResultURL
Below are the variable outputs from the gateway during the multiple stages in the SERVER Result Delivery Method. Also, the…
Request Hash Digest Pushed To Merchants ServerResultURL
Below is the order that the variables should be listed when creating the hash digest to check against the one…
Expected Response From Merchant’s ServerResultURL
These are the response variables from the merchant’s external server (ServerResultURL). NOTE: the merchant’s server MUST adhere to this specification.…
SERVER Output Variables
These are the output variables delivered to the merchant’s CallbackURL after the transaction has been processed. These variables will be…
SERVER Output Hash Digest
Below is the order that the variables should be listed when creating the hash digest to check against the one…
SERVER_PULL Result Delivery Method
Below are the variable outputs from the gateway during the multiple stages in the SERVER_PULL Result Delivery Method. Also, the…
SERVER_PULL Output Variables
These are the output variables delivered to the merchant’s CallbackURL after the transaction has been processed. These variables will be…
SERVER_PULL Output Hash Digest
Below is the order that the variables should be listed when creating the hash digest to check against the one…
SERVER_PULL Request Variables
These are the request variables directly posted by the merchant’s website to our transaction result query handler. The external URL…
Transaction Result PULL Response
These are the response variables from our transaction result query handler. Variable Name Data Type Max Length Comments StatusCode A…
SERVER_PULL Transaction Result Variables
These are the transaction result variables. These variables are used to allow the merchant to display the payment result to…
Appendix 1: Gateway Response Status Codes
Below are the status codes likely to be received when integrating with the gateway. Status Code Transaction Result Description …
Appendix 2: Transaction Data Flow
Listed below are the steps that a Transparent Redirect transaction will take. All of the methods are the same in…
All Result Delivery Methods
The cardholder navigates to the merchant’s website. Once an order has been prepared, the customer is redirected to the…
POST Result Delivery Method
The results of the transaction are then passed back to the merchant’s system (CallbackURL). The data passed to the Merchant’s…
SERVER Result Delivery Method
Below are the variable outputs from the gateway during the multiple stages in the SERVER Result Delivery Method. Also, the…
SERVER_PULL Result Delivery Method
The customer is redirected back to the merchant’s system (CallbackURL). The data passed to the Merchant’s System should be…
POST Result Delivery Method – Request
This is a sample SALE transaction HTML form for the POST result delivery method which is submitted to the gateway…
SERVER Result Delivery Method – Request
This is a sample SALE transaction HTML form for the SERVER result delivery method which is submitted to the gateway…
SERVER Result Delivery Method – Reply to Gateway Response
This is an example reply the merchants system would give the gateway as part of the SERVER result delivery method.…
SERVER_PULL Result Delivery Method – Request
<form action=”https://mms.paymentprocessor.net/Pages/PublicPages/PaymentForm.aspx” method=”post”> <input type=”hidden” value=”184e4739835b7c6099f900a06d5aebf811bd8814″ name=”HashDigest”> <input type=”hidden” value=”VALID_MERCHANT_ID_HERE” name=”MerchantID”> <input type=”hidden” value=”1000″ name=”Amount”> <input type=”hidden” value=”826″ name=”CurrencyCode”> <input…
Hosted Payment Form – Response
This is an example transaction result response from the gateway. Depending on the chosen result delivery method, this may be…
Appendix 4: Transaction Result Status Codes
The StatusCode is a numerical value representation for the result of the transaction. If any other code is returned not…
Override AVS Policy Codes
The OverrideAVSPolicy codes are 4 character codes which instruct the gateway how to handle the AVS checking for that particular…
Hosted Payment Form Character 1 Codes
Character Code Explanation E This code means fail the transaction if either the address numeric check or post code check…
Character 2 Codes
Character Code Explanation P Treat partial address numeric results as passes F Treat partial address numeric results as failures …
Character 3 Codes
Character Code Explanation P Treat partial post code results as passes F Treat partial post code results as failures …
Character 4 Codes
Character Code Explanation P ThiscodemeanspassthetransactionifbothresultsoftheAVScheckarenotknown F ThiscodemeansfailthetransactionifbothresultsoftheAVScheckarenotknown
Examples
EFFF – this is the strongest policy & transactions will only pass if both address numeric & post code checks…
Questions
Q: Why would the results of the AVS check be unknown? A: The main reasons for the results of the…
Override CV2 Policy Codes
The OverrideCV2Policy codes are 2 character codes which instruct the gateway how to handle the CV2 checking for that particular…
Character 1 Codes
Character Code Explanation P This code means pass the transaction if the CV2 check has failed F This code means…
Character 2 Codes
Character Code Explanation P ThiscodemeanspassthetransactionifbothresultsoftheCV2checkarenotknown F Thiscodemeansfailthetransactionifbothresultsofthe CV2 checkarenotknown
Examples
FF – this is the strongest policy & transactions will only pass if the CV2 check has passed FP –…
Hosted Payment Form Questions
Q: Why would the CV2 result be unknown? A: The main reasons for the result being unknown are: The CV2…
Appendix 6: Country (ISO 3166-1) Codes
ISO Code Country 826 United Kingdom 840 United States 036 Australia 004 Afghanistan 248 Åland Islands 008 Albania…
Appendix 7: Currency ISO 4217 Codes (2)
ISO Code Currency 826 Pound Sterling 840 US Dollar 978 Euro 971 Afghani 12 Algerian Dinar 32 Argentine…