Intended Audience – Direct Integration
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 – Direct Integration
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://gw1. paymentprocessor.net/). When using these URL’s…
Gateway Messages
The gateway accepts data in the form of SOAP (v1.1) XML messages over HTTPS.
Notation Explained
The message variables are primarily described using a hierarchical table – the hierarchy information is implied by the indentation amount…
Introduction
The CardDetailsTransaction message is the mainstay of the gateway. It is the one message that merchants must implement in order…
Request
Below are the details for the request message to initiate a transaction where the card details are submitted. Tag/Attribute Name…
Response
Below are the details for the response that will be received after sending a CardDetailsTransaction request. Tag/Attribute Name Data Type…
CrossReferenceTransaction
Introduction Cross reference transactions are primarily used so that the merchant can run subsequent transactions against previous transactions without having…
ThreeDSecureAuthentication
Introduction The 3D Secure authentication request is used when the initial transaction has been returned as requiring the customer to…
PayByLinkQuery
Introduction This message returns a list of transaction details processed under the queried PayByLink. Request Below are the details for…
TransactionQuery
Introduction This message returns the details for a queried transaction. Request Tag/Attribute Name Data Type Max Length Mandatory Comments TransactionQueryMessage…
Get CardType
Introduction This message allows the merchant to determine the card type of the card in question. Request Below are the…
Get Gateway Entry Points
Introduction This message returns the details of all the gateway entry points Request Below are the details for the request…
Introduction – Direct Integration
The payment gateway has been designed to address the modern business electronic payment and credit card processing needs. Our gateway…
Gateway Entry Points
As you may be aware, the gateway has multiple entry points. That is you can communicate with the gateway through…
Gateway Entry Point Metric
The gateway entry point metric is a vital piece of information received from the gateway. Using one of the two…
Gateway Entry Point Selection Methods
Blind Processing Description This method is what you may find in the integration sample pack code. The nature of this…
Entry Point State Awareness
Description This method differs from the ‘Blind Processing’ method greatly. The nature of this method is to not fire transactions…
Appendix 1: Gateway Response StatusCodes
Below are the status codes likely to be received when integrating with the gateway. Status Code Transaction Result Description 0…
CardDetailsTransaction – Request–PaymentMessage
This describes the root PaymentMessage node of the CardDetailsTransaction request message This describes the TransactionDetails child node of the root…
Response – CardDetailsTransactionResponse
This describes the root CardDetailsTransactionResponse node of the CardDetailsTransaction response message This describes the CardDetailsTransactionResult child node of the root…
Request –PaymentMessage
This describes the root PaymentMessage node of the CrossReferenceTransaction request message This describes the TransactionDetails child node of the root…
Response – CrossReferenceTransaction
This describes the root CrossReferenceTransactionResponse node of the CrossReferenceTransaction response message ThisdescribestheCrossReferenceTransactionResultchildnodeoftheroot CrossReferenceTransactionResponse node This describes the PreviousTransactionResult child node…
Request –ThreeDSecureMessage
This describes the root ThreeDSecureMessage node of the ThreeDSecureAuthentication request message
Response –ThreeDSecureAuthentication
This describes the root ThreeDSecureAuthenticationResponse node of the ThreeDSecureAuthentication response message This describes the ThreeDSecureAuthenticationResult child node of the root…
Request –GetCardTypeMessage
This describes the root GetCardTypeMessage node of the GetCardType request message
Response –GetCardTypeResponse
This describes the root GetCardTypeResponse node of the GetCardType response message This describes the GetCardTypeResult child node of the root…
Request – GetGatewayEntryPointsMessage
This describes the root GetGatewayEntryPointsMessage node of the GetGatewayEntryPointsrequest message
Response – GetGatewayEntryPointsResponse
This describes the root GetCardTypeMessage node of the GetCardType request message This describes the GetGatewayEntryPointsResult child node of the root…
CardDetailsTransaction Request –CardDetailsTransaction
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <CardDetailsTransaction xmlns=“https://www.thepaymentgateway.net/“> <PaymentMessage> <MerchantAuthentication MerchantID=“MerchantID” Password=“Password” /> <TransactionDetails Amount=“1000” CurrencyCode=“826”> <MessageDetails TransactionType=“SALE”…
Response– CardDetailsTransactionResponse (Notrequiring3DSecure authentication)
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <CardDetailsTransactionResponse xmlns=“https://www.thepaymentgateway.net/“> <CardDetailsTransactionResult AuthorisationAttempted=“true”> <StatusCode>0</StatusCode> <Message>Auth Code: 123456</Message> </CardDetailsTransactionResult> <TransactionOutputData CrossReference=“07010101010010101010102” ExternalCrossReference=“58792488326099422839“…
Response–CardDetailsTransactionResponse (Requiring3DSecure authentication)
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <CardDetailsTransactionResponse xmlns=“https://www.thepaymentgateway.net/“> <CardDetailsTransactionResult AuthorisationAttempted=“true”> <StatusCode>3</StatusCode> <Message>Issuer authentication Required</Message> </CardDetailsTransactionResult> <TransactionOutputData CrossReference=“07010101010010101010102“> <AddressNumericCheckResult>UNKNOWN</AddressNumericCheckResult>…
Request –CrossReferenceTransaction
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <CrossReferenceTransaction xmlns=“https://www.thepaymentgateway.net/“> <PaymentMessage> <MerchantAuthentication MerchantID=“MerchantID” Password=“Password” /> <TransactionDetails Amount=“1000” CurrencyCode=“826”> <MessageDetails TransactionType=“COLLECTION”…
Response – CrossReferenceTransactionResponse
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <CrossReferenceTransactionResponse xmlns=“https://www.thepaymentgateway.net/“> <CrossReferenceTransactionResult AuthorisationAttempted=“True”> <StatusCode>0</StatusCode> <Message>Auth Code:123456</Message> </CrossReferenceTransactionResult> <TransactionOutputData CrossReference=“07010101010010101010102” ExternalCrossReference=“58792488326099422839“ ExternalClientReference=“15764860733312436602“…
Request –ThreeDSecureAuthentication
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <ThreeDSecureAuthentication xmlns=“https://www.thepaymentgateway.net/“> <ThreeDSecureMessage> <MerchantAuthentication MerchantID=“MerchantID” Password=“Password” /> <ThreeDSecureInputData CrossReference=“070101010101010101010104”> <PaRES> eJycVF1zojAU/SsO+7hjE75EnZiOrdL6wbZFbN3HCBFoIWgCovz6DWots7MPu8sLN4d7zz3nXibo9pAmrT3lIs7YQFFvoN KizM+CmIUDZenZ7a5yi5EXcUpHC+oXnGLkUCFISFtxMFAMo6tZmgW1noLR89ClAqMLHZZsNxoCn0dZx/2IsBwj4u/uJj+w…
Response – ThreeDSecureAuthenticationResponse
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <ThreeDSecureAuthenticationResponse xmlns=“https://www.thepaymentgateway.net/“> <ThreeDSecureAuthenticationResult AuthorisationAttempted=“True”> <StatusCode>0</StatusCode> <Message>Auth Code:123456</Message> </ThreeDSecureAuthenticationResult> <TransactionOutputData CrossReference=“07010101010010101010102” ExternalCrossReference=“58792488326099422839“ ExternalClientReference=“15764860733312436602“…
Request –GetCardType
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <GetCardType xmlns=“https://www.thepaymentgateway.net/“> <GetCardTypeMessage> <MerchantAuthentication MerchantID=“MerchantID” Password=“Password” /> <CardNumber>5600000000005390</CardNumber> </GetCardTypeMessage> </GetCardType> </soap:Body> </soap:Envelope>
Response –GetCardTypeResponse
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <GetCardTypeResponse xmlns=“https://www.thepaymentgateway.net/“> <GetCardTypeResult> <StatusCode>0</StatusCode> </GetCardTypeResult> <GetCardTypeOutputData> <CardTypeData> <CardType>MAESTRO_INTERNATIONAL</CardType> <Issuer>HSBC</Issuer> <LuhnCheckRequired>True</LuhnCheckRequired> <IssueNumberStatus>IGNORED_IF_SUBMITTED</IssueNumberStatus> </CardTypeData>…
Request –GetGatewayEntryPoints
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <GetGatewayEntryPoints xmlns=“https://www.thepaymentgateway.net/“> <GetGatewayEntryPointsMessage> <MerchantAuthentication MerchantID=“MerchantID” Password=“Password” /> </GetGatewayEntryPointsMessage> </GetGatewayEntryPoints> </soap:Body> </soap:Envelope>
Response – GetGatewayEntryPointsResponse
<?xml version=“1.0” encoding=“utf-8”?> <soap:Envelope xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“ xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/“> <soap:Body> <GetGatewayEntryPointsResponse xmlns=“https://www.thepaymentgateway.net/“> <GetGatewayEntryPointsResult> <StatusCode>0</StatusCode> </GetGatewayEntryPointsResult> <GatewayEntryPointsOutputData> <GatewayEntryPoints> <GatewayEntryPoint EntryPointURL=“https://gw1.paymentprocessor.net” Metric=“100”/> <GatewayEntryPoint EntryPointURL=“https://gw2.paymentprocessor.net”…
OverrideAVSPolicy Codes
The OverrideAVSPolicy codes are 2 character codes which instruct the gateway how to handle the AVS checking for that particular…
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 Explanation
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 This code means pass the transaction if both results of the AVS check are not known…
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…
OverrideCV2Policy Codes
The OverrideAVSPolicy codes are 2 character codes which instruct the gateway how to handle the AVS checking for that particular…
Direct Integration Guide 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 This code means pass the transaction if both results of the AVS check are not known…
Examples
FF – this is the strongest policy & transactions will only pass if the CV2 check has passed FP –…
Direct Integration Questions
Q: Why would the CV2 result be unknown? A: The main reasons for the result being unknown are: The CV2…
Appendix 5: List of Card Types
Below is a list of the card types that may be returned by the gateway Card Type Full Name UNKNOWN…
The 3D Secure System Explained
The 3D Secure system is a scheme implemented by the card schemes (primarily Visa, who call it Verified By Visa…
ACS Simulator 4 possible conditions
The test system comes complete with an ACS simulator, which allows your developer to simulate the most common responses that…
Appendix 7: Country (ISO 3166-1) Codes
ISO Code Country 826 United Kingdom 840 United States 036 Australia 004 Afghanistan 248 Åland Islands 008 Albania 012…
Appendix 8: Currency (ISO 4217) Codes – Payb
ISO Code Currency 826 Pound Sterling 840 US Dollar 978 Euro 971 Afghani 12 Algerian Dinar 32 Argentine Peso…