Myvirtual Userguide

Virtual API
Version 8.0.0
Merchant User Guide
MyGate Communication (Pty) Ltd Reg. No: 2006/018060/07, Vat No: 4020234409 Tel: +27 21 555 3260, Website: www.mygate.co.za
Introduction: ......................................................................................................... 5 Overview: ............................................................................................................. 6 MyGates role in the transaction process: ............................................................. 7 MyGate Payment Solutions:................................................................................. 8 The MyGate Web Console: .................................................................................. 9 Global IP Recognition (GIR) ............................................................................10 Repeated Failure Identification (RFI) ...............................................................10 Repeated Successful Identification (RSI) ........................................................10 Unique Client Index (UCI)................................................................................10 Blacklisting.......................................................................................................10 3D-Secure: ..........................................................................................................11 What is 3D Secure?.........................................................................................11 How does 3D-Secure work with MyGate? .......................................................11 What are the advantages of 3D-Secure?.........................................................12 Credit Card Processing: ......................................................................................13 Variables to Be Posted To MyGate:.................................................................13 Shopping-Cart Variables that can be posted to MyGate:.................................16 MyVirtual HTML Code Example: .....................................................................17 MyVirtual Shopping Cart Code Example: ........................................................18 RCCB Integration: ...............................................................................................20 RCCB Overview: .............................................................................................20 RCCB Variables to Be Posted To MyGate: .....................................................21 RCCB HTML Code Example: ..........................................................................24 Cell Pay Point Integration:...................................................................................26 Variables to be Posted to MyGate: ..................................................................26 HTML example core requirements ..................................................................28
HTML example when send through shopping cart details ...............................29 eBucks Integration: .............................................................................................30 Variables to be Posted to MyGate: ..................................................................30 eBucks HTML Example: ..................................................................................32 mimoney Integration:...........................................................................................33 Variables to be Posted to MyGate: ..................................................................33 mimoney HTML Code Example: ......................................................................35 SNAP Integration: ...............................................................................................36 Variables to be Posted to MyGate: ..................................................................36 SNAP HTML Code Example:...........................................................................38 Testing the Payment Gateway: ...........................................................................39 FNB Successful Test Card Details:..................................................................39 FNB Failed Test Card Details: .........................................................................39 Nedbank Successful Test Card Details: ..........................................................39 Nedbank Failed Test Card Details:..................................................................39 mimoney Test Voucher Details:.......................................................................39 Return Variables from MyGate:...........................................................................40 MyGate Encryption:.............................................................................................41 Encryption Webservice: ...................................................................................42 Decryption Webservice:...................................................................................42 Error Codes:........................................................................................................43 1xxx = MyVirtual - Validation Response Codes ...............................................43 2xxx = MyVirtual - Initiating Response Codes .................................................48 4xxx = MyVirtual - Security Response Codes..................................................50 5xxx = MyVirtual - Gateways Response Code.................................................51
6xxx = MyVirtual - Fraud Module Response Code ..........................................52 8xxx = MyVirtual Warnings Codes................................................................52 9xxx = MyVirtual - Unexpected Error ...............................................................54 1xx 2xx mimoney Error Codes......................................................................54
Introduction:
Since the inception of MyGate, the MyVirtual Payment Solution has been the most popular in the market. This is largely due to the ease of integration into the solution and the high level of Security that it provides to Merchants. The MyVirtual Solution also has the ability to be customized to such an extent that your client would feel as though they are on your website while making payment ensuring peace-of-mind throughout the checkout process. MyGate also pride ourselves on our level of security. The Virtual Payment Page is operating behind a SSL (Secure Socket Layer) Certificate and all information that is captured on the payment page is encrypted using 128-bit encryption ensuring that your clients credit card details are kept safe. MyGate is also fully PCI-Compliant meaning that our systems have gone through rigorous testing and certification procedures to ensure that your clients information remains confidential and is not prone to attacks or theft.
Overview:
MyVirtual allows the merchant to utilize the MyGate payment webpage. This means that your clients will be directed to MyGates Payment page where they will enter their credit card details in order for the transaction to be completed. The payment information which MyGate requires is posted to MyGate via a form POST. This POST can be done in any language that supports this method. The process of the transaction is as follows:
One of the main benefits of utilising the MyVirtual Solution is the simplicity in which to integrate it into your online website. It requires less development work than other MyGate Solutions and security measures are already incorporated by MyGate. This is beneficial to you as you do not need to go through the process of becoming PCI-Compliant and/or obtaining a SSL Certificate.
MyGates role in the transaction process:

As the Payment Service Provider (Payment Gateway), MyGates role in the transaction process is as follows: MyGate receives the transaction details from the Website via form POST. MyGate accepts the details from the buyer. MyGate does validation ensuring that the buyer entered valid information. MyGate Processes the transaction by submitting the transaction details to the merchant bank in a live environment. The merchant bank processes the transaction and returns to MyGate with a result and/or error code. MyGate returns this result and/or error code with error description back ro the Merchant Website address specified in the form POST. If the functionality is set up (from the MyGate Web Console) MyGate will notify the card holder via email of the transaction details and the merchant via email and/or SMS.
MyGate will also provide the merchant with access to the MyGate Web Console. Here, the merchant will be able to view the transactions in a live environment along with their transactional status (Authorized, Settled, Refunded, etc). The client will also be able to view the client details along with the items purchased provided they get submitted to MyGate in the form POST from the website.
Website Orders Payment Gateway
Bank
MyGate Payment Solutions:

MyGate offers a variety of payment solutions beyond the scope of credit card processing:
Credit Card Processing:

VISA, MasterCard, Diners Club and American Express credit card payments can be accepted from anywhere in the world. They are a global form of payment which creates endless opportunities for both the merchant and the card holder. Any business which does not have a credit card facility can now easily incorporate our payment solution into their existing systems. With MyGate, all card types are processed in real-time. Bank settlement generally occurs the next day. Complete control is maintained over all transaction types such as authorisation, settlement, reversals and refunds.
Cell Pay Point:

Cell Pay Point which is an alternative payment method offered by FNB for ecommerce companies. Cell Pay Point enables merchants to accept payments on their website from registered FNB Mobile Banking users. The solution allows FNB Mobile Banking Users to pay from their debit card account via their mobile phone.
eBucks:
MyGate is an approved eBucks payment processor. eBucks internet partners can integrate into MyGate through a simple web service allowing authorization and settlement of eBucks tokens.
mimoney:
mimoney is a new method of payment for use by people who want to shop online but do not have a credit card - or do not wish to use their creditcard details online. mimoney, is an electronic payment voucher that is simple, easy to use, and truly secure.
SNAP:
SNAP provides the consumer with a comprehensive payment card for all sorts of electronic transactions, including Internet Shopping, Money Transfer and Mobile Payments. For accepting merchant, SNAP is a secure and convenient way to bring cash customers to the web, grow revenues and eliminate charge-backs.
The MyGate Web Console:

The MyGate Web Console was developed for use by the Merchant as a means to manage their transactions from a central point. It is the most advanced of its kind and is the leading management and reconciliation tool in the market. The MyGate Web Console enables the merchant to perform the following tasks: View Transactions that have gone through the payment gateway. Settle Transactions that are authorized. Refund Transactions. Make use of the MyTerminal System (online swipe machine (MOTO environment)) Activate and configure the MyGate Fraud Module. Activate and configure the NotifyMe Service. Load the Referral URL. Customize the MyVirtual Payment Page. Perform Reconciliations on payments on a daily basis. Manage Chargebacks should they arise. Settle Transactions with an Authorization number.
Your role (as the developer) will be to notify the merchant of the referral URL (this is the last URL on the website before the client is redirected to MyGate). The merchant will need to load this URL in his Web Console in order for live transactions to be processed. The merchant needs to do the following to load the referral URL: Log into the MyGate Web Console (www.mygate.co.za/console) Click on Settings. Click on Gateway Settings. Click on the configure icon. Load the referral URL. Click on Save.
The MyGate Fraud Module:

MyGate understands the risk of chargebacks and has developed an extensive range of fraud systems allowing the merchant to manage his business more effectively in real time.
Global IP Recognition (GIR) GIR compares the purchaser's delivery address to the global geographic location assigned to their IP address. If someone was purchasing on your website and their billing address is in the UK but their IP address is in Germany, it would be likely that the transaction is fraudulent. Repeated Failure Identification (RFI) RFI works in conjunction with blacklisting and allows the merchant to set the amount of failed attempts a purchaser can make before they are blocked from making further attempts. If a purchaser makes too many purchase attempts without success, it may mean that they are not the cardholder and the transaction could be fraudulent. Repeated Successful Identification (RSI) RSI allows the merchant to set the amount of successful transactions a purchaser can make before theyre flagged as potential fraud or blocked from making further transactions. A purchaser is defined from IP address or credit card number. Unique Client Index (UCI) UCI forms a one-to-one relationship between a client and a credit card number. The merchant has the ability to provide MyGate with a unique-client-identifier when processing a transaction. MyGate then stores the card number used by that client, and will flag or fail later transactions used by this client with a different card number. This insures that the credit card being used by the client is the card previously used for transacting. Blacklisting Blacklisting allows you to block purchase attempts on the payment gateway. You are able to blacklist fraudulent purchases which may have been picked up from either charge backs or any one of MyGates Fraud Detection Tools by blocking one or more of the below from your Merchant Interface: Blocking e-mail domains, i.e. any address at gmail.com Blocking specific credit card numbers Blocking specific e-mail addresses Blocking specific countries, cities or regions
10
3D-Secure:
Internet transactions are classed as 'cardholder not present' (CNP) transactions. 3D Secure helps to identify a cardholder and confirm that it was indeed the legitimate cardholder entering the card details. The majority of chargebacks can arise as a result of the cardholder denying that they authorized a transaction, making it difficult for you to successfully dispute this sort of chargeback. The 3D Secure technology is designed to reduce the possibility of fraudulent card use by authenticating the cardholder at the actual time of the transaction and subsequently reducing your exposure to disputed transactions and chargebacks of this type. What is 3D Secure? 3D Secure stands for Three Domain Secure - the payment industry's internet authentication standard which has been developed by the major card schemes. Visa has called their version of the scheme 'Verified by Visa' and MasterCard have called their equivalent initiative 'MasterCard SecureCode'. These are both collectively referred to as 3D Secure. 3D Secure authentication requires the cardholder to register their card to take advantage of this service. This is a one time process which takes place on the card issuer's website and involves the cardholder answering several security questions to which only the card issuer and cardholder will know the answer. The cardholder selects a password and agrees on a secret phrase, which will be used by the card issuer during each online transaction. 3D Secure can be thought of as an online version of 'Chip and Pin' technology, whereby the cardholder has a personalized password registered with their card that is entered during the checkout process. 3D Secure is predicted to become the industry standard by the end of 2010 and all online consumers will soon become as familiar with this, as when they enter their 'Pin' number at a cash machine or till in a shop. How does 3D-Secure work with MyGate? Each time a cardholder attempts to make a transaction using MyGate, after entering their personal card details on the MyGate payment page, the MyGate system automatically checks to see if their card is enrolled in the 3D Secure scheme. Some schemes are not yet fully enabled for 3D Secure but these are expected to be enabled over the next few months. If the cardholders' bank is participating, the cardholder is taken to their card issuers secure website where they enter their 3D Secure password. The payment is then taken as normal and the cardholder is smoothly delivered back to the merchants confirmation page. If a cardholder of a bank who is participating in the 3D Secure scheme has not yet enrolled, by default, they are offered the opportunity to register. They can then either sign up for 3D Secure, and proceed with the transaction or decline to sign up and proceed
11
with the transaction as normal. Different card issuers may implement a maximum decline limit before the cardholder is made to sign up to 3D Secure. MyGate will attempt a 3D Secure check on each card transaction - if the cardholder's bank are not currently participating in the 3D Secure scheme, the transaction will be processed without a 3D Secure check. All MyGate Merchant Accounts are now 3D Secure enabled as standard and each MyGate card transactions is checked to see if the cardholder is registered for 3D Secure. Merchants and Sellers should use the notification of the 3D Secure checks as an additional fraud prevention tool in conjunction with existing fraud checks such as AVS and CV2 to help you minimise your risk of fraud.
What are the advantages of 3D-Secure? The key attraction to you as a merchant is that once a cardholder registered with the scheme has input their correct 3D Secure password during a transaction and this has been successfully authenticated (and providing that they are acting legally), the liability of a chargeback arising from the cardholder denying that they authorised the transaction, should shift from you (the merchant) to the cardholder's issuing bank. If a customer is not yet registered with the scheme, the fact that the transaction is checked by MyGate for 3D Secure compliance should give similar protection from the customer denying that they processed the transaction (providing the customer's bank is participating in the 3D Secure scheme). Increased card holder confidence, leading to increased sales. Currently, around 50% of cardholders have not participated in an electronic transaction. Early adoption - 3D Secure looks set to become the leading security system for online credit card transactions. Give your customers peace of mind and show you care about their security. No additional fees.
12
Credit Card Processing:

Variables to Be Posted To MyGate:
The below variables detail what needs to be submitted to MyGate in the form POST: POST URL: https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm
Variable Name Mode txtMerchantID
Explanation Specifies a Live or Test transaction Your merchant UID allocated by MyGate
Required Yes Yes
txtApplicationID
Your Application UID allocated by MyGate
Yes
txtMerchantReference
txtPrice
This is any unique number that you refer to the transaction with. (e.g. Invoice Number, Order Number) The Price of the transaction
Yes
Data 0 = Test 1 = Live xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) AlphaNumeric. Must be between 4 and 16 characters long.
Yes
txtCurrencyCode txtDisplayPrice
txtDisplayCurrencyCode
The 3 letter currency code. This is used if you want to display a different currency to your users and the price needs to show differently. The data in txtPrice and the currency in txtCurrencyCode is what will be billed off the users account. This is used if you want to display a different currency to your users. The data in txtPrice and the currency in txtCurrencyCode is what will be billed off the users
Yes No
Numeric with 2 decimal places (The decimal places are determined by the currency you specify) E.g. 150.00 3 Letters as specified in ISO4217 (e.g. ZAR) Numeric with 2 decimal places.
No
3 Letters as specified in ISO4217 (e.g. ZAR).
13
txtRedirectSuccessfulURL
txtRedirectFailedURL
ShippingCountryCode
UCI
IPAddress
txtQty
account. This is the url the system will redirect to in the event of a completed successful transaction This is the url the system will redirect to in the event of a completed failed transaction This represents the 2 letter country code of the country to which the item/s are being shipped. This is part of the MyGate Fraud Module, and is used by the following fraud products: BLS (Blacklisting Service) AND GIR (Global IP Recognition Service). Unique Client Index - is any Alphanumeric combination that uniquely identifies the client. It is part of the MyGate Fraud Module, and is used by the following fraud products: BLS (Blacklisting Service) AND UCI (Unique Client Identifier Service). This represents the IP Address of the online purchaser. It is part of the Fraud Module, and is used by the following fraud products: RSI (Repeated Success Identifier Service), RFI (Repeated Failure Identifier Service), BLS (Blacklisting Service), and GIR (Global IP Recognition Service). The Number of line items that were ordered Item Reference Number allows you to link the
Yes
A fully qualified URL (e.g. http://www.mygate.co.za/successf ul.htm). A fully qualified URL (e.g. http://www.mygate.co.za/failed.ht m). 2 Letters as specified in ISO4217 (e.g. ZA, UK, US, DK, MX)
Yes
No
No
AlphaNumeric (MaxLength: 128)
No
AlphaNumeric, representing the users IP Address eg 172.16.32.182
Yes
Numeric (1 or greater)
txtItemRef
No
AlphaNumeric (MaxLength: 256)
14
txtItemDescr txtItemAmount txtShippingCost txtDiscount txtRecipient
txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5 txtQty txtItemRef
txtItemDescr
txtItemAmount
txtShippingCost txtDiscount Variable1, Variable2, Variable3, etc
item back to an item reference number in your shopping cart Item Description The Price paid by the purchaser for the item Shipping Costs for the order Discount given on the order The name of the individual who has placed the order on your shopping site The Shipping Address Line 1 The Shipping Address Line 2 The Shipping Address Line 3 The Shipping Address Line 4 The Shipping Address Line 5 The Quantity of the shipped item (Optional but Required if txtQty is posted) The Reference of the shipped item (Optional but Required if txtQty is posted) The Description of the shipped item (Optional but Required if txtQty is posted) The total value of the shipped item The shipping cost of the full shipments The discount given of the full shipments These are variables we will pass through for you should you need it. They will be posted to the success and failed pages in addition to the Transaction Result.
Yes Yes No No No
AlphaNumeric (MaxLength: 512) Numeric with 2 decimal places Numeric with 2 decimal places Numeric with 2 decimal places AlphaNumeric (MaxLength: 128)
No No No No No No No
AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) Numeric e.g. 2 AlphaNumeric (MaxLength: 128) e.g. btv1203
No
AlphaNumeric (MaxLength: 128) e.g. Black Plasma
No
Numeric with 2 decimal places e.g. 12.300.00 Numeric with 2 decimal places e.g. 250.00 Numeric with 2 decimal places e.g. 1000.00 Any characters that comply with W3 HTML standards.
No No No
15
Shopping-Cart Variables that can be posted to MyGate:

MyGate has added the additional ability for MyVirtual merchants to optionally send through shopping cart details to the payment page. This information is then displayed above the creditcard input fields. In addition, once the order is processed and the credit-card transaction created, this shopping-cart data is then stored in our database and linked to the transaction. At any time, you as the merchant can then log into the MyGate Web Console and go to the Search Option under Transactions Menu Item, and view the purchased items associated with any transaction (this is particularly useful for reconciliation purposes). The fields required to be populated to make use of this new service are detailed below. Please be sure to view the code example below to see how to correctly pass through shopping cart parameters to the payment page. Please note that you can send any number of line items through to the payment page, but they need to be distinguished by being suffixed with 1,2,3 etc. after each line item. Therefore, if the online purchaser is buying two line items, these would be sent through to MyGate as follows: <input type="hidden" <input type="hidden" <input type="hidden" <input type="hidden" <input type="hidden" <input type="hidden" <input type="hidden" <input type="hidden" name="txtQty1" value="1"> name="txtItemRef1" value="Any Item Ref Here"> name="txtItemDescr1"value="Any Item Description Here"> name="txtItemAmount1" value="123.45"> name="txtQty2" value="1"> name="txtItemRef2" value=" Any Item Ref Here "> name="txtItemDescr2value="Any Item Description Here"> name="txtItemAmount2" value="456.78">
16
MyVirtual HTML Code Example:

The below HTML example details only the required variables that need to be posted to MyGate. This is simply an example to see how a form POST is done to MyGate: <FORM name="PostTest action="https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm" method="post"> <input type="hidden" name="Mode" value="0"> <input type="hidden" name="txtMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1"> <input type="hidden" name="txtApplicationID" value="d48750f9-1dc0-4290-a94c9a1c9f7e2fb1"> <input type="hidden" name="txtMerchantReference" value="INV15642"> <input type="hidden" name="txtPrice" value="29.99"> <input type="hidden" name="txtCurrencyCode" value="ZAR"> <input type="hidden" name="txtRedirectSuccessfulURL" value="http://www.mygate.co.za/successful.htm"> <input type="hidden" name="txtRedirectFailedURL" value="http://www.mygate.co.za/failed.htm"> <input type="submit" value="Send Details"> </FORM> The above code can be copied into your code for testing purposes. Please note however, that before going live, you will need to change the details in the above example. Please also note that the Merchant UID and Application UID in the above code are for the MyGate test account. They will work only for testing purposes. You will need to replace these details with the Merchant and Application UID provided to you by MyGate in your integration welcome email.
17
MyVirtual Shopping Cart Code Example:

The Below HTML example shows how your form POST could look when extensive information is getting sent to MyGate: <FORM name="Post" action=https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm method="post"> <input type="hidden" name="Mode" value="0"> <input type="hidden" name="txtMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1"> <input type="hidden" name="txtApplicationID" value="d48750f9-1dc0-4290-a94c9a1c9f7e2fb1"> <input type="hidden" name="txtMerchantReference" value="INV15642"> <input type="hidden" name="txtPrice" value="15.00"> <input type="hidden" name="txtCurrencyCode" value="ZAR"> <input type="hidden" name="txtRedirectSuccessfulURL" value="http://localhost/success_failure.php"> <input type="hidden" name="txtRedirectFailedURL" value="http://localhost/success_failure.php"> <input type="hidden" name=" ShippingCountryCode " value="ZA"> <input type="hidden" name="UCI" value="14A23B"> <input type="hidden" name=" IPAddress " value="172.16.3.18">  <input type="hidden" name="Variable1" value="My security check variable"> <input type="hidden" name="Variable2" value="INV15642">  <input type="hidden" name="txtQty1" value="1"> <input type="hidden" name="txtItemRef1" value="Item Ref 1"> <input type="hidden" name="txtItemDescr1" value="ItemDescription 1"> <input type="hidden" name="txtItemAmount1" value="5">  <input type="hidden" name="txtQty2" value="2"> <input type="hidden" name="txtItemRef2" value="Item Ref 2"> <input type="hidden" name="txtItemDescr2" value="ItemDescription 2"> <input type="hidden" name="txtItemAmount2" value="5">  <input type="hidden" name="txtShippingCost" value="0.00"> <input type="hidden" name="txtDiscount" value="0.00">  <input type="hidden" name="txtRecipient" value="Joe Soap"> <input type="hidden" name="txtShippingAddress1" value="15 Yorke Street"> <input type="hidden" name="txtShippingAddress2" value="Gardens"> <input type="hidden" name="txtShippingAddress3" value="Cape Town"> <input type="hidden" name="txtShippingAddress4" value="8000"> <input type="hidden" name="txtShippingAddress5" value="South Africa"> <input type="submit" value="Send Details">
18
</FORM>
The above code can be copied into your code for testing purposes. Please note however, that before going live, you will need to change the details in the above example. Please also note that the Merchant UID and Application UID in the above code are for the MyGate test account. They will work only for testing purposes. You will need to replace these details with the Merchant and Application UID provided to you by MyGate in your integration welcome email.
19
RCCB Integration:
RCCB Overview:
RCCB (Recurring Credit Card Billing) is a solution typically used by subscription websites or any other website that requires the card holder to be debited from their credit card automatically on a monthly basis. The RCCB POST to MyGate is slightly different to the standard MyVirtual POST in that it includes additional variables that need to be sent to MyGate in order for us to process the transaction automatically on a monthly basis. MyGate does not post back to your website on each subsequent rebill that we do. We will only POST back to your site on the initial transaction. Transaction statuses along with RCCB transaction statuses can be viewed in the MyGate Web Console. The MyGate Web Console also plays another important role in the RCCB Solution: It allows the merchant to edit and/or delete clients from the RCCB bill cycle.
20
RCCB Variables to Be Posted To MyGate:

Below is a list of the additional variables that need to be posted to MyGate along with the standard MyVirtual Variables: The URL that you will post to for an RCCB transaction is: https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm Variable Name ACCB_Frequency Explanation The Frequency of how often a transaction should happen. The format should always be in the correct format like below: Weekly(W) | Action Day (DDD) Monthly(M) | Action Day (dd) Bi-Annually(B) Required Yes Data AlphaNumeric (MaxLength: 5) e.g. Weekly W|Mon Monthly M|01 The last day of the month is depicted as M|31 - regardless of whether or not the month contains 31 days, if the frequency is set to this value, the debit will go off against the RCCB client on the last day of every month. Bi-Annually Y ACCB_StartDate The Start Date of the automatic debits. It must be in the format dd-MMM-yyyy The End Date of the automatic debits. It must be in the format dd-MMM-yyyy The Amount that will be collected on the specified Frequency. This must be greater Yes Date Eg 01-Feb-2008
ACCB_EndDate
Yes
Date Eg 01-Feb-2009
ACCB_Amount
Yes
Numeric with 2 decimal places e.g. 150.00
21
ACCB_ClientName
ACCB_ClientAccountNo
ACCB_ClientEmailAddress
ACCB_ClientSendEmail
ACCB_ClientMobileNo
ACCB_ClientSendSMS
txtACCB_Caption
txtFrequency_Caption
txtACCBAmount_Caption
than 0 A description of the client. This will be the name of the company or individual, etc. A unique merchant reference for the collection. This is purely for your reference. The client email address in the event that the client needs to be notified Enable the facility to notify the client via email when a transaction takes place. This will defaults to No The clients mobile number in the event that the client needs to be notified Enable the facility to notify the client via SMS when a transaction takes place. This will defaults to No The RCCB header can be changed with this field. It will default to Repeated-Payment Details The Frequency Label can be changed with this field. It will default to Payment Frequency The Amount Label can be changed with this field. It will default to Payment Amount
Yes
AlphaNumeric (MaxLength: 64) e.g Joe Soap
Yes
AlphaNumeric (MaxLength: 64) e.g. Acc123043
No
Text e.g. test@mydomain.co.za Boolean e.g.: 0 = No 1 = Yes
No
No
Text e.g. 0830000000
No
Boolean e.g: 0 = No 1 = Yes
No
Text e.g. Recurring Billing
No
Text e.g. Recurring Frequency
No
Text e.g. Recurring Amount
22
ShowACCBDetails
This display the RCCB details for the client on the payment page. This will defaults to Yes This display the Frequency for the client on the payment page. This will defaults to Yes This display the Start Date for the client on the payment page. This will defaults to Yes This display the End Date for the client on the payment page. This will defaults to Yes This display the Collection Amount for the client on the payment page. This will defaults to Yes
No
Boolean e.g. 0 = No 1 = Yes
ShowFrequencyDetails
No
ShowStartDateDetails
No
ShowEndDateDetails
No
ShowAmountDetails
No
23
RCCB HTML Code Example:

Below is an HTML code example of what an RCCB POST can look like: <FORM name="Post" action="https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm" method="post"> <input type="hidden" name="Mode" value="0"> <input type="hidden" name="txtMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1"> <input type="hidden" name="txtApplicationID" value="d48750f9-1dc0-4290-a94c9a1c9f7e2fb1"> <input type="hidden" name="txtMerchantReference" value="INV15642"> <input type="hidden" name="txtPrice" value="15.00"> <input type="hidden" name="txtCurrencyCode" value="ZAR"> <input type="hidden" name="txtDisplayPrice" value="15.00"> <input type="hidden" name="txtDisplayCurrencyCode" value="ZAR"> <input type="hidden" name="txtRedirectSuccessfulURL" value="http://localhost/ success_failure.php"> <input type="hidden" name="txtRedirectFailedURL" value="http://localhost/ success_failure.php"> <input type="hidden" name=" ShippingCountryCode " value="ZA"> <input type="hidden" name="UCI" value="14A23B"> <input type="hidden" name=" IPAddress " value="172.16.3.18">  <input type="hidden" name="Variable1" value="My security check variable"> <input type="hidden" name="Variable2" value="INV15642">  <input type="hidden" name="txtQty1" value="1"> <input type="hidden" name="txtItemRef1" value="Item Ref 1"> <input type="hidden" name="txtItemDescr1" value="ItemDescription 1"> <input type="hidden" name="txtItemAmount1" value="5">  <input type="hidden" name="txtQty2" value="2"> <input type="hidden" name="txtItemRef2" value="Item Ref 2"> <input type="hidden" name="txtItemDescr2" value="ItemDescription 2"> <input type="hidden" name="txtItemAmount2" value="5">  <input type="hidden" name="txtShippingCost" value="0.00"> <input type="hidden" name="txtDiscount" value="0.00">  <input type="hidden" name="txtRecipient" value="Joe Soap"> <input type="hidden" name="txtShippingAddress1" value="15 Yorke Street"> <input type="hidden" name="txtShippingAddress2" value="Gardens"> <input type="hidden" name="txtShippingAddress3" value="Cape Town"> <input type="hidden" name="txtShippingAddress4" value="8000"> <input type="hidden" name="txtShippingAddress5" value="South Africa">
24
 <input type="hidden" name="txtFrequency" value="M|1"> <input type="hidden" name="txtStartDate" value="01-DEC-2007"> <input type="hidden" name="txtEndDate" value="01-DEC-2008"> <input type="hidden" name="txtACCBAmount" value="5.00"> <input type="hidden" name="txtACCBClientName" value="David Viljoen"> <input type="hidden" name="txtACCBClientAccountNo" value="Test02"> <input type="hidden" name="txtACCBClientEmailAddress" value="test@mygate.co.za"> <input type="hidden" name="txtACCBClientMobileNumber" value="0831234567"> <input type="hidden" name="txtACCBClientSendSMS" value="0"> <input type="hidden" name="txtACCBClientSendEmail" value="0">  <input type="hidden" name="ShowACCBDetails" value="1"> <input type="hidden" name="ShowFrequencyDetails" value="1"> <input type="hidden" name="ShowStartDateDetails" value="1"> <input type="hidden" name="ShowEndDateDetails" value="1"> <input type="hidden" name="ShowAmountDetails" value="1">  <input type="hidden" name="txtACCB_Caption" value="Recurring Billing"> <input type="hidden" name="txtFrequency_Caption" value="Payment Frequency"> <input type="hidden" name="txtACCBAmount_Caption" value="Monthly Billing"> <input type="submit" value="Send Details"> </FORM> The above code can be copied into your code for testing purposes. Please note however, that before going live, you will need to change the details in the above example. Please also note that the Merchant UID and Application UID in the above code are for the MyGate test account. They will work only for testing purposes. You will need to replace these details with the Merchant and Application UID provided to you by MyGate in your integration welcome email.
25
Cell Pay Point Integration:

Variables to be Posted to MyGate:
You will do a form POST to the following URL: https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm
Variable Name txtMode
txtMerchantID
Explanation (Required) The mode determines whether the transaction is to be done in live mode or test mode. (Required) Your merchant ID allocated by MyGate
Data 0 = Test 1 = Live xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) AlphaNumeric
txtApplicationID
txtMerchantStatementR ef txtCustomerStatement Ref txtPrice
(Required) Your Application ID allocated by MyGate (if you are a current MyVirtual merchant, your current MyVirtual Application ID can be used) (Required) This is any unique number that you refer to the transaction with. (e.g. Invoice Number, Order Number) (Required) This is the reference that will appear on your bank statement when you receive payment for the transaction (Required) This is the reference that will appear on the customers bank statement when they receive payment for the transaction (Required) The Price of the transaction
AlphaNumeric (20 chars max)
AlphaNumeric (20 chars max)
txtCurrencyCode txtDisplayPrice
txtDisplayCurrencyCod e
txtRedirectSuccessfulU RL
(Required) The 3 letter currency code as agreed with FNB (Optional) This is used if you want to display a different currency to your users and the price needs to show differently. The data in txtPrice and the currency in txtCurrencyCode is what will be billed off the users account. (Optional) This is used if you want to display a different currency to your users. The data in txtPrice and the currency in txtCurrencyCode is what will be billed off the users account. (Required) This is the url the system will redirect to in the event of a completed
Numeric with 2 decimal places (The decimal places are determined by the currency you specify) 3 Letters as specified in ISO4217 (e.g. ZAR) Any Numeric Value
3 Letters as specified in ISO4217 (e.g. ZAR)
A fully qualified URL (e.g. http://www.mygate.co.za/succe
26
txtRedirectFailedURL
txtRecipient txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5 txtQty txtItemRef
successful transaction (Required) This is the url the system will redirect to in the event of a completed failed transaction (Optional) The name of the individual who has placed the order on your shopping site (Optional) The Shipping Address Line 1 (Optional) The Shipping Address Line 2 (Optional) The Shipping Address Line 3 (Optional) The Shipping Address Line 4 (Optional) The Shipping Address Line 5 (Optional) The Quantity of the shipped item (Optional but Required if txtQty is posted) The Reference of the shipped item (Optional but Required if txtQty is posted) The Description of the shipped item (Optional but Required if txtQty is posted) The total value of the shipped item (Optional) The shipping cost of the full shipments (Optional) The discount given of the full shipments (Optional) These are variables we will pass through for you should you need it. They will be posted to the success and failed pages in addition to the Transaction Result.
txtItemDescr
txtItemAmount txtShippingCost txtDiscount Variable1, Variable2, Variable3, etc
ssful.htm) A fully qualified URL (e.g. http://www.mygate.co.za/failed. htm) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) Numeric e.g. 2 AlphaNumeric (MaxLength: 128) e.g. btv1203 AlphaNumeric (MaxLength: 128) e.g. Black Plasma Numeric with 2 decimal places e.g. 12,300.00 Numeric with 2 decimal places e.g. 250.00 Numeric with 2 decimal places e.g. 1000.00 Any characters that comply with W3 HTML standards.
27
HTML example core requirements

<FORM name="PostTest" action="https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm" method="post"> <input type="hidden" name="txtMode" value="0"> <input type="hidden" name="txtMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1"> <input type="hidden" name="txtApplicationID" value="d48750f9-1dc0-4290-a94c9a1c9f7e2fb1"> <input type="hidden" name="txtMerchantReference" value="INV15642"> <input type="hidden" name="txtMerchantStatementRef" value="CPPMerchRef"> <input type="hidden" name="txtCustomerStatementRef" value="CPPClientRef"> <input type="hidden" name="txtPrice" value="29.99"> <input type="hidden" name="txtCurrencyCode" value="ZAR"> <input type="hidden" name="txtDisplayPrice" value="29.99"> <input type="hidden" name="txtDisplayCurrencyCode" value="ZAR"> <input type="hidden" name="txtRedirectSuccessfulURL" value="http://www.mygate.co.za/successful.htm"> <input type="hidden" name="txtRedirectFailedURL" value="http://www.mygate.co.za/failed.htm"> <input type="hidden" name="Variable1" value="My security check variable"> <input type="hidden" name="Variable2" value="INV15642"> <input type="submit" value="Send Details"> </FORM>
28
HTML example when send through shopping cart details

<FORM name="PostTest" action="https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm" method="post"> <input type="hidden" name="txtMode" value="0"> <input type="hidden" name="txtMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1"> <input type="hidden" name="txtApplicationID" value="d48750f9-1dc0-4290-a94c9a1c9f7e2fb1"> <input type="hidden" name="txtMerchantReference" value="INV15642"> <input type="hidden" name="txtMerchantStatementRef" value="CPPMerchRef"> <input type="hidden" name="txtCustomerStatementRef" value="CPPClientRef"> <input type="hidden" name="txtPrice" value="29.99"> <input type="hidden" name="txtCurrencyCode" value="ZAR"> <input type="hidden" name="txtDisplayPrice" value="29.99"> <input type="hidden" name="txtDisplayCurrencyCode" value="ZAR"> <input type="hidden" name="txtRedirectSuccessfulURL" value="http://www.mygate.co.za/successful.htm"> <input type="hidden" name="txtRedirectFailedURL" value="http://www.mygate.co.za/failed.htm">  <input type="hidden" name="Variable1" value="My security check variable"> <input type="hidden" name="Variable2" value="INV15642">  <input type="hidden" name="txtQty1" value="1"> <input type="hidden" name="txtItemRef1" value="Item Ref 1"> <input type="hidden" name="txtItemDescr1" value="ItemDescription 1"> <input type="hidden" name="txtItemAmount1" value="5">  <input type="hidden" name="txtQty2" value="2"> <input type="hidden" name="txtItemRef2" value="Item Ref 2"> <input type="hidden" name="txtItemDescr2" value="ItemDescription 2"> <input type="hidden" name="txtItemAmount2" value="5">  <input type="hidden" name="txtShippingCost" value="0.00"> <input type="hidden" name="txtDiscount" value="0.00">  <input type="hidden" name="txtRecipient" value="Glenn Ross"> <input type="hidden" name="txtShippingAddress1" value="15 Yorke Street"> <input type="hidden" name="txtShippingAddress2" value="Gardens"> <input type="hidden" name="txtShippingAddress3" value="Cape Town"> <input type="hidden" name="txtShippingAddress4" value="8000"> <input type="hidden" name="txtShippingAddress5" value="South Africa"> <input type="submit" value="Send Details"> </FORM>
29
eBucks Integration:
To process an eBucks transaction, you will do a form POST to the following URL: https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm Variable Name txtMyGateMerchantID Explanation (Required) Your merchant ID allocated by MyGate (Required) Your eBucks merchant ID allocated by FNB (Required) The number of items of different item codes (see fields below) that the enduser wishes to purchase with their eBucks (Required) Your Application ID allocated by MyGate (Required) This is any unique number that you refer to the transaction with. (e.g. Invoice Number, Order Number) (Required) The Price of the transaction Data xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) A numeric value A numeric value
txtEBucksMerchantID txtInvoiceNumberItems
txtApplicationID
xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) AlphaNumeric
txtPrice
txtCurrencyCode txtRedirectSuccessfulU RL txtRedirectFailedURL
txtItemCode1, txtItemCode2 etc.
txtItemName1, txtItemName2 etc.
txtUnitCount1, txtUnitCount2 etc. txtUnitCost1, txtUnitCost2 etc.
(Required) The 3 letter currency code as agreed with FNB (Required) This is the url the system will redirect to in the event of a completed successful transaction (Required) This is the url the system will redirect to in the event of a completed failed transaction (Required) Codes of items being purchased (for item reference & identification). The number of individual items must equal the number specified in the txtInvoiceNumberItems field (Required) Names of items being purchased. The number of individual items must equal the number specified in the txtInvoiceNumberItems field (Required) Numbers of items per each item code being purchased. (Required) Cost of items per each item code being purchased.
Numeric with 2 decimal places (The decimal places are determined by the currency you specify) 3 Letters as specified in ISO4217 (e.g. ZAR) A fully qualified URL (e.g. http://www.mygate.co.za/successful .htm) A fully qualified URL (e.g. http://www.mygate.co.za/failed.htm) AlphaNumeric
AlphaNumeric
A numeric value A numeric value
30
txtItemFlatDiscount1, txtItemFlatDiscount2 etc. txtPercentageDiscount1 txtPercentageDiscount2 etc txtRecipient txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5 Variable1, Variable2, Variable3, etc
(Required) Flat discount offered per each item code being purchased. (Required) Percentage discount offered per each item code being purchased. (Optional) The name of the individual who has placed the order on your shopping site (Optional) The Shipping Address Line 1 (Optional) The Shipping Address Line 2 (Optional) The Shipping Address Line 3 (Optional) The Shipping Address Line 4 (Optional) The Shipping Address Line 5 (Optional) These are variables we will pass through for you should you need it. They will be posted to the success and failed pages in addition to the Transaction Result.
A numeric value (0 for no discount)
A numeric value (0 for no discount)
AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) Any characters that comply with W3 HTML standards.
31
eBucks HTML Example:

<FORM name="PostTest" action="https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm" method="post"> <input type="hidden" name="txtMyGateMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1> <input type=" hidden " name="txtEBucksMerchantID" value="1895> <input type=" hidden " name="txtInvoiceNumberItems" value="2"> <input type=" hidden " name="txtApplicationID" value="d48750f9-1dc0-4290-a94c9a1c9f7e2fb1"> <input type=" hidden " name="txtMerchantReference" value="gs56776"> <input type=" hidden " name="txtPrice" value="0.10"> <input type=" hidden " name="txtDisplayPrice" value="0.10"> <input type=" hidden " name="txtCurrencyCode" value="ZAR"> <input type=" hidden " name="txtDisplayCurrencyCode" value="R"> <input type=" hidden " name="txtRedirectSuccessfulURL" value="http://mysite/eBucksASPTest/Success.aspx"> <input type=" hidden " name="txtRedirectFailedURL" value="http://mysite/eBucksASPTest/Failure.aspx"> <input type=" hidden " name="Variable1" value="this is variable 1"> <input type=" hidden " name="Variable2" value="this is variable 2"> <input type=" hidden " name="txtItemCode1" value="Item Code 1"> <input type=" hidden " name="txtItemName1" value="ItemName 1"> <input type=" hidden " name="txtItemDescr1" value="ItemDescription 1"> <input type=" hidden " name="txtUnitCount1" value="1"> <input type=" hidden " name="txtUnitCost1" value="0.05"> <input type=" hidden " name="txtItemFlatDiscount1" value="0"> <input type="hidden" name="txtPercentageDiscount1" value="0"> <input type=" hidden " <input type=" hidden " <input type=" hidden " <input type=" hidden " <input type=" hidden " <input type=" hidden " <input type=" hidden " name="txtItemCode2" value="Item Code 2"> name="txtItemName2" value="ItemName 2"> name="txtItemDescr2" value="ItemDescription 2"> name="txtUnitCount2" value="1"> name="txtUnitCost2" value="0.05"> name="txtItemFlatDiscount2" value="0"> name="txtPercentageDiscount2" value="0">
<input type=" hidden " name="txtRecipient" value="Joe Williams"> <input type=" hidden " name="txtShippingAddress1" value="27 York Street"> <input type=" hidden " name="txtShippingAddress2" value="Newtown"> <input type=" hidden " name="txtShippingAddress3" value="Cape Town"> <input type=" hidden " name="txtShippingAddress4" value="7706"> <input type=" hidden " name="txtShippingAddress5" value="South Africa"> <input type="submit" value="Send Details">
32
mimoney Integration:
To initiate a mimoney transaction, you will need to POST to the following URL: https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm Variable Name txtMode Explanation (Required) The mode determines whether the transaction is to be done in live mode or test mode. (Required) Your merchant ID allocated by MyGate Data 0 = Test 1 = Live xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) AlphaNumeric
txtMerchantID
txtApplicationID
txtPrice
(Required) Your Application ID allocated by MyGate (if you are a current MyVirtual merchant, your current MyVirtual Application ID can be used) (Required) This is any unique number that you refer to the transaction with. (e.g. Invoice Number, Order Number) (Required) The Price of the transaction
txtRecipient txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5
(Required) The 3 letter currency code as agreed with mimoney (Required) This is the url the system will redirect to in the event of a completed successful transaction (Required) This is the url the system will redirect to in the event of a completed failed transaction (Optional) The name of the individual who has placed the order on your shopping site (Optional) The Shipping Address Line 1 (Optional) The Shipping Address Line 2 (Optional) The Shipping Address Line 3 (Optional) The Shipping Address Line 4 (Optional) The Shipping Address Line 5
Numeric with 2 decimal places (The decimal places are determined by the currency you specify) 3 Letters as specified in ISO4217 (e.g. ZAR) A fully qualified URL (e.g. http://www.mygate.co.za/succe ssful.htm) A fully qualified URL (e.g. http://www.mygate.co.za/failed. htm) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128)
33
txtQty txtItemRef
(Optional) The Quantity of the shipped item (Optional but Required if txtQty is posted) The Reference of the shipped item (Optional but Required if txtQty is posted) The Description of the shipped item (Optional but Required if txtQty is posted) The total value of the shipped item (Optional) The shipping cost of the full shipments (Optional) The discount given of the full shipments (Optional) These are variables we will pass through for you should you need it. They will be posted to the success and failed pages in addition to the Transaction Result.
txtItemDescr
Numeric e.g. 2 AlphaNumeric (MaxLength: 128) e.g. btv1203 AlphaNumeric (MaxLength: 128) e.g. Black Plasma Numeric with 2 decimal places e.g. 12,300.00 Numeric with 2 decimal places e.g. 250.00 Numeric with 2 decimal places e.g. 1000.00 Any characters that comply with W3 HTML standards.
34
mimoney HTML Code Example:

<FORM name="PostTest" action="https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm" method="post"> <input type="hidden" name="txtMode" value="0"> <input type="hidden" name="txtMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1"> <input type="hidden" name="txtApplicationID" value="d48750f9-1dc0-4290-a94c9a1c9f7e2fb1"> <input type="hidden" name="txtMerchantReference" value="INV15642"> <input type="hidden" name="txtPrice" value="29.99"> <input type="hidden" name="txtCurrencyCode" value="ZAR"> <input type="hidden" name="txtRedirectSuccessfulURL" value="http://www.mygate.co.za/successful.htm"> <input type="hidden" name="txtRedirectFailedURL" value="http://www.mygate.co.za/failed.htm">  <input type="hidden" name="txtQty1" value="1"> <input type="hidden" name="txtItemRef1" value="Item Ref 1"> <input type="hidden" name="txtItemDescr1" value="ItemDescription 1"> <input type="hidden" name="txtItemAmount1" value="5">  <input type="hidden" name="txtQty2" value="2"> <input type="hidden" name="txtItemRef2" value="Item Ref 2"> <input type="hidden" name="txtItemDescr2" value="ItemDescription 2"> <input type="hidden" name="txtItemAmount2" value="5">  <input type="hidden" name="txtShippingCost" value="0.00"> <input type="hidden" name="txtDiscount" value="0.00">  <input type="hidden" name="txtRecipient" value="John Williams"> <input type="hidden" name="txtShippingAddress1" value="15 Yorke Street"> <input type="hidden" name="txtShippingAddress2" value="Gardens"> <input type="hidden" name="txtShippingAddress3" value="Cape Town"> <input type="hidden" name="txtShippingAddress4" value="8000"> <input type="hidden" name="txtShippingAddress5" value="South Africa"> <input type="hidden" name="Variable1" value="My security check variable"> <input type="hidden" name="Variable2" value="INV15642"> <input type="submit" value="Send Details"> </FORM>
35
SNAP Integration:
To initiate a SNAP transaction, you will need to POST to the following URL: https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm Variable Name txtMode Explanation (Required) The mode determines whether the transaction is to be done in live mode or test mode. (Required) Your merchant ID allocated by MyGate Data 0 = Test 1 = Live xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) AlphaNumeric
txtMerchantID
txtApplicationID
txtPrice
(Required) Your Application ID allocated by MyGate (if you are a current MyVirtual merchant, your current MyVirtual Application ID can be used) (Required) This is any unique number that you refer to the transaction with. (e.g. Invoice Number, Order Number) (Required) The Price of the transaction
txtRecipient txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5
(Required) The 3 letter currency code as agreed with SNAP (Required) This is the url the system will redirect to in the event of a completed successful transaction (Required) This is the url the system will redirect to in the event of a completed failed transaction (Optional) The name of the individual who has placed the order on your shopping site (Optional) The Shipping Address Line 1 (Optional) The Shipping Address Line 2 (Optional) The Shipping Address Line 3 (Optional) The Shipping Address Line 4 (Optional) The Shipping Address Line 5
Numeric with 2 decimal places (The decimal places are determined by the currency you specify) 3 Letters as specified in ISO4217 (e.g. ZAR) A fully qualified URL (e.g. http://www.mygate.co.za/succe ssful.htm) A fully qualified URL (e.g. http://www.mygate.co.za/failed. htm) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128) AlphaNumeric (MaxLength: 128)
36
txtQty txtItemRef
(Optional) The Quantity of the shipped item (Optional but Required if txtQty is posted) The Reference of the shipped item (Optional but Required if txtQty is posted) The Description of the shipped item (Optional but Required if txtQty is posted) The total value of the shipped item (Optional) The shipping cost of the full shipments (Optional) The discount given of the full shipments (Optional) These are variables we will pass through for you should you need it. They will be posted to the success and failed pages in addition to the Transaction Result.
txtItemDescr
Numeric e.g. 2 AlphaNumeric (MaxLength: 128) e.g. btv1203 AlphaNumeric (MaxLength: 128) e.g. Black Plasma Numeric with 2 decimal places e.g. 12,300.00 Numeric with 2 decimal places e.g. 250.00 Numeric with 2 decimal places e.g. 1000.00 Any characters that comply with W3 HTML standards.
37
SNAP HTML Code Example:

<FORM name="PostTest" action="https://www.mygate.co.za/virtual/8x0x0/dsp_ecommercepaymentparent.cfm" method="post"> <input type="hidden" name="txtMode" value="0"> <input type="hidden" name="txtMerchantID" value="79958a8d-0c7b-4038-8e2e8948e1d678e1"> <input type="hidden" name="txtApplicationID" value=" d5ed8aec-9615-4e64-97ebd28948b78b7d"> <input type="hidden" name="txtMerchantReference" value="INV15642"> <input type="hidden" name="txtPrice" value="29.99"> <input type="hidden" name="txtCurrencyCode" value="ZAR"> <input type="hidden" name="txtRedirectSuccessfulURL" value="http://www.mygate.co.za/successful.htm"> <input type="hidden" name="txtRedirectFailedURL" value="http://www.mygate.co.za/failed.htm">  <input type="hidden" name="txtQty1" value="1"> <input type="hidden" name="txtItemRef1" value="Item Ref 1"> <input type="hidden" name="txtItemDescr1" value="ItemDescription 1"> <input type="hidden" name="txtItemAmount1" value="5">  <input type="hidden" name="txtQty2" value="2"> <input type="hidden" name="txtItemRef2" value="Item Ref 2"> <input type="hidden" name="txtItemDescr2" value="ItemDescription 2"> <input type="hidden" name="txtItemAmount2" value="5">  <input type="hidden" name="txtShippingCost" value="0.00"> <input type="hidden" name="txtDiscount" value="0.00">  <input type="hidden" name="txtRecipient" value="John Williams"> <input type="hidden" name="txtShippingAddress1" value="15 Yorke Street"> <input type="hidden" name="txtShippingAddress2" value="Gardens"> <input type="hidden" name="txtShippingAddress3" value="Cape Town"> <input type="hidden" name="txtShippingAddress4" value="8000"> <input type="hidden" name="txtShippingAddress5" value="South Africa"> <input type="hidden" name="Variable1" value="My security check variable"> <input type="hidden" name="Variable2" value="INV15642"> <input type="submit" value="Send Details"> </FORM>
38
Testing the Payment Gateway:

While Testing the Gateway, there are two sets of card details that can be used to simulate both successful and failed responses from MyGate: FNB Successful Test Card Details: Card Name Card Number (No spaces) Card Type Card Expiry Date CCV Number FNB Failed Test Card Details: Card Name Card Number (No spaces) Card Type Card Expiry Date CCV Number Nedbank Successful Test Card Details: Card Name Card Number (No spaces) Card Type Card Expiry Date CCV Number Nedbank Failed Test Card Details: Card Name Card Number (No spaces) Card Type Card Expiry Date CCV Number mimoney Test Voucher Details: Voucher Number Cell Phone Number * Voucher Number (for failure) * Cell Phone Number (for failure) 111122223333444455 Any Number Any 18 digit number Any number Joe Soap 4111111111111111 Visa Any time in the future 123 Joe Soap 4242424242424242 Visa Any time in the future 123 Joe Soap 4242424242424242 Visa Any time in the future 123 Joe Soap 4111111111111111 Visa Any time in the future 123
Once the gateway is enabled for live trading, you should also perform a test withlive details to ensure that the live system is working to your satisfaction.
39
Return Variables from MyGate:

On each Successful and/or failed transaction, MyGate returns a result along with other variables to your Success/Failure page specified in your form POST. These return variables can then be used to do a number of things, namely: Display an appropriate message to your client. Update a database on your system. Update the order status of an order.
Below are the variables that MyGate return to your website via POST: Variable Name _RESULT Explanation This contains the transaction result code which will indicate if the transaction was successful or failed. This is the error code should one exist This is the source of the error which can be provided to us for tracking purposes This is the error message This is the detail of the error message This is the error code returned by the bank after authorization This is the error message returned by the bank after authorization This is the 3D Secure status of a credit card. The county of the issuing credit card bank These are your variables returned to you if they were specified in the original post page. (See Variables to be posted to MyVirtual) Data 0 >0 <0
= Success = Successful with Warning = Failed
_ERROR_CODE _ERROR_SOURCE
AlphaNumeric AlphaNumeric
_ERROR_MESSAGE _ERROR_DETAIL _BANK_ERROR_CODE _BANK_ERROR_MESSAGE
AlphaNumeric AlphaNumeric AlphaNumeric AlphaNumeric
_3DSTATUS _CARDCOUNTRY VARIABLE1, VARIABLE2, VARIABLE3, etc
Numeric AlphaNumeric AlphaNumeric
40
MyGate Encryption:
As an additional security measure, MyGate has implemented an encryption function that allows you to have a security variable sent through to MyGate that is encrypted using DES encryption. The process of how to implement this is as follows: The card holder goes through the checkout process on your website and comes to the final checkout page on your website. Your website invokes a Coldfusion webservice that takes a variable as a parameter, encrypts it and returns the encrypted value back to your server. This encrypted value is then populated as an additional variable in your form POST to MyGate with the name txtTransactionID and will have the value of the returned value in its encrypted format. MyGate processes your transaction normally and returns the card holder back to your success/failure URL. When MyGate redirects the card holder back to your website, an additional return variable is now returned: _TRANSACTIONID. This return variable is posted along with the other return variables and contains the following information: txtMerchantReference || txtTransactionID || txtPrice This return variable is in an encrypted format so you will still need to decrypt it. The decryption can be done by invoking an additional webservice that will take the encrypted variable as a parameter, decrypts it and returns the unencrypted value. This can then be used to compare the values and ensure that the values are correct.
An example of how to invoke the encryption and decryption webservice is provided below:
41
Encryption Webservice: <?php $client = new SoapClient ("https://www.mygate.co.za/virtual/6x0x0/mygate_encryption.cfc?wsdl"); $arrResults = $client->dataEncryption( 'D48750F9-1DC0-4290-A94C-9A1C9F7E2FB1', 'Security Variable' ); print_r(explode('||', $arrResults)); echo("<br />"); ?> //txtApplicationUID //String to be encrypted
Decryption Webservice: <?php $client = new SoapClient ("https://www.mygate.co.za/virtual/6x0x0/mygate_encryption.cfc?wsdl"); $arrResults = $client->dataDecryption ( 'D48750F9-1DC0-4290-A94C-9A1C9F7E2FB1', B37AEAAA386D517DB188BD49EFDBE4FD' ); print_r(explode('||', $arrResults)); echo("<br />"); ?> The above code examples are written in php. Please note that you can use any server side scripting language to invoke these webservices. Please also note that the encryption and decryption function uses an encryption and decryption key. This key is stored on MyGates systems ensuring that they remain secure. You can use the above txtApplicationUID in the example to test the encryption facility, but before you can go live with it, you would need to provide MyGate with the encryption key of your choice. This will then be loaded to your account and used to encrypt and decrypt your values.
//txtApplicationUID //Encrypted value to be decrypted
42
Error Codes:
Although MyGate returns an error message as a return variable, you may wish to display custom error messages to your clients based on the error code returned by MyGate. For this reason, below is a full list of error codes returned by MyGate in the event of a failed/declined transaction: 1xxx = MyVirtual - Validation Response Codes Code 1001 Message Gateway Required Description A gateway was not specified. Please check that you have entered a gateway. If this problem persists, please contact support at support@mygate.co.za A Merchant ID was not specified. Please check that you have entered a Merchant ID. If this problem persists, please contact support at support@mygate.co.za An invalid merchant UID was specified. Please check that you have entered the correct merchant id. The Merchant UID can be retrieved from either the integration email or from the MyGate Web Console. If this problem persists, please contact support at support@mygate.co.za An application UID was not specified. Please check that you have entered an application id. The Application UID can be retrieved from either the integration email or from the MyGate Web Console. If this problem persists, please contact support at support@mygate.co.za An invalid application ID was specified. Please check that you have entered the correct application id. The Application UID can be retrieved from either the integration email or from the MyGate Web Console. If this problem persists, please contact support at support@mygate.co.za An Action was not specified. Please check that you have entered an Action. If this problem persists, please contact support at support@mygate.co.za An invalid action was specified. A valid action is one of the following: {1, 2, 3, 4}. If this problem persists, please contact support at support@mygate.co.za An invalid TransactionIndex was specified. Please check that you have entered the correct TransactionIndex. If this problem persists, please contact support at support@mygate.co.za A Terminal was not specified. Please check that you have entered a Terminal. If this problem
1002
MerchantID Required
1003
Invalid Merchant UID
1004
ApplicationUID Required
1005
Invalid ApplicationUID
1006
Action Required
1007
Invalid Action
1008
Invalid Transaction Index
1009
Terminal Required
43
1010
Invalid Terminal
1011
Mode Required
1012
Invalid Mode
1013
MerchantReference Required
1014
Invalid MerchantReference
1015
Amount Required
1016
Zero Amount
1017
Invalid Amount
1018
Currency Required
1019
TransactionIndex required
1020
CardType required
1021
Invalid CardType
persists, please contact support at support@mygate.co.za An invalid terminal was specified. A terminal is an alphanumeric string with a minimum of 4 and a maximum of 16 characters. If this problem persists, please contact support at support@mygate.co.za A Mode was not specified. Please check that you have entered a Mode. If this problem persists, please contact support at support@mygate.co.za An invalid mode was specified. A mode is a value specifying either 1=LIVE or 0=TEST mode. If this problem persists, please contact support at support@mygate.co.za A MerchantReference was not specified. Please check that you have entered a MerchantReference. The merchant reference is specified by the website and is typically the order number. If this problem persists, please contact support at support@mygate.co.za An invalid MerchantReference was specified. A MerchantReference is an alphanumeric string with a minimum of 4 and a maximum of 16 characters. If this problem persists, please contact support at support@mygate.co.za An Amount was not specified. Please check that you have entered an Amount. If this problem persists, please contact support at support@mygate.co.za A zero amount is not allowed. Check that you have specified the right amount. If this problem persists, please contact support at support@mygate.co.za An invalid Amount was specified. An amount needs to be in the format: RR.cc (50.00). If this problem persists, please contact support at support@mygate.co.za A Currency was not specified. Please check that you have entered a currency (ZAR). If this problem persists, please contact support at support@mygate.co.za This transaction requires a TransactionIndex. Please specify a correct transaction index. If this problem persists, please contact support at support@mygate.co.za This Card Type is required. Please specify a correct Card Type. If this problem persists, please contact support at support@mygate.co.za An invalid Card Type was specified. A valid Card Type is a number from 1 to 4. If this problem persists, please contact support at support@mygate.co.za
44
1022
CardNumber required
1023
Invalid Currency
1024
Invalid CardNumber
1025
CCVNumber required
1026
Invalid CCVNumber
1027
ExpiryMonth Required
1028
ExpiryYear Required
1029
Invalid ExpiryMonth
1030
Invalid ExpiryYear
1031
Past Expiry Date
1032
Account Type Required
1033
Invalid Account Type
1034
Card Holder Required
1035
Invalid Card Holder
1036
Invalid CCV for this card type
The Card Number is required. Please specify a correct Card Number. If this problem persists, please contact support at support@mygate.co.za An invalid Currency was specified. Describe requirements of ISO4217. If this problem persists, please contact support at support@mygate.co.za An invalid Card Number was specified. Please specify a valid Card Number. If this problem persists, please contact support at support@mygate.co.za This Credit Card Verification Number is required. Please specify a correct Credit Card Verification Number. If this problem persists, please contact support at support@mygate.co.za An invalid Credit Card Verification Number was specified. Please specify a valid Credit Card Verification Number. If this problem persists, please contact support at support@mygate.co.za An Expiry Month is required for this transaction. If this problem persists, please contact support at support@mygate.co.za An Expiry Year is required for this transaction. If this problem persists, please contact support at support@mygate.co.za An invalid Expiry Month was specified. If this problem persists, please contact support at support@mygate.co.za An invalid Expiry Year was specified. If this problem persists, please contact support at support@mygate.co.za The expiry date is in the past. If this problem persists, please contact support at support@mygate.co.za An account type was not specified. Please check that you have entered an account type. If this problem persists, please contact support at support@mygate.co.za An invalid Account Type was specified. A valid account type is a number between 1 and 3 inclusive. If this problem persists, please contact support at support@mygate.co.za A Card Holder was not specified. Please check that you have entered a card holder. If this problem persists, please contact support at support@mygate.co.za An invalid Card Holder was specified. A valid alphanumeric string of max length 255 must be specified. If this problem persists, please contact support at support@mygate.co.za An invalid CCV was specified for this card type. A
45
1037
Invalid Budget
1038
Budget Period Required
1039
Invalid Budget Period
1040
Amount Required
1041
Zero Amount
1042
Invalid Amount
1043
Invalid Authorisation
1044
Invalid Budget
1045
AuthorisationNumber Required
1046
PIN Required
1047
Invalid PIN
1048
eCommerceIndicator Required
1049
Invalid eCommerceIndicator
valid CCV Number is. If this problem persists, please contact support at support@mygate.co.za An invalid Budget was specified. A valid number 1 or 0 must be specified. If this problem persists, please contact support at support@mygate.co.za A budget period was not specified. Please check that you have entered a budget period. If this problem persists, please contact support at support@mygate.co.za An invalid budget period was specified. A valid number between was expected. If this problem persists, please contact support at support@mygate.co.za A Cashback Amount was not specified. Please check that you have entered a cashback Amount. If this problem persists, please contact support at support@mygate.co.za A zero cashback amount is not allowed. Check that you have specified the right cashback amount. If this problem persists, please contact support at support@mygate.co.za An invalid cashback Amount was specified. {Describe requirements of ISO4217}. If this problem persists, please contact support at support@mygate.co.za An invalid authorisation was specified. Please check that you have entered a valid authorisation number. If this problem persists, please contact support at support@mygate.co.za An invalid budget was specified. Please check that you have entered a valid budget number (0 or 1). If this problem persists, please contact support at support@mygate.co.za An authorisation number was not specified. Please check that you have entered an Authorisation Number. If this problem persists, please contact support at support@mygate.co.za A PIN was not specified. Please check that you have entered a PIN. If this problem persists, please contact support at support@mygate.co.za An invalid PIN was specified. A valid PIN was expected. If this problem persists, please contact support at support@mygate.co.za An eCommerceIndicator was not specified. Please check that you have entered an eCommerceIndicator. If this problem persists, please contact support at support@mygate.co.za An invalid eCommerceIndicator was specified. A valid eCommerceIndicator was expected. If this problem persists, please contact support at
46
1050
verifiedByVisaXID Required
1051
Invalid verifiedByVisaXID
1052
verifiedByVisaCAVV Required
1053
Invalid verifiedByVisaCAVV
support@mygate.co.za A verifiedByVisaXID was not specified. Please check that you have entered a verifiedByVisaXID. If this problem persists, please contact support at support@mygate.co.za An invalid verifiedByVisaXID was specified. A valid verifiedByVisaXID was expected. If this problem persists, please contact support at support@mygate.co.za A verifiedByVisaCAVV was not specified. Please check that you have entered a verifiedByVisaCAVV. If this problem persists, please contact support at support@mygate.co.za An invalid verifiedByVisaCAVV was specified. A valid verifiedByVisaCAVV was expected. If this problem persists, please contact support at support@mygate.co.za
1054
secureCodeUCAF Required
1055
Invalid secureCodeUCAF
1056
SSL Required
1057
UCI Required
1058
Invalid UCI
1059
IP Address Required
1060
Invalid Public IP Address
A secureCodeUCAF was not specified. Please check that you have entered a secureCodeUCAF. If this problem persists, please contact support at support@mygate.co.za An invalid secureCodeUCAF was specified. A valid secureCodeUCAF was expected. If this problem persists, please contact support at support@mygate.co.za This service must be called using SSL (https). If this problem persists, please contact support at support@mygate.co.za A UCI was not specified. Please check that you have entered a UCI. If this problem persists, please contact support at support@mygate.co.za An invalid UCI was specified. A valid UCI was expected containing only a combination of upper and lower case letters, numbers, - (dash) and _ (underscore); having a maximum length of 128 characters. If this problem persists, please contact support at support@mygate.co.za A IP Address was not specified. Please check that you have entered a IP Address. If this problem persists, please contact support at support@mygate.co.za An invalid Public IP Address was specified. A valid Public IP Address is expected, please note that private IP addresses are excluded and defined as codified in RFC1597, RFC1918, RFC3330, RFC3927. If this problem persists, please contact
47
1061
Shipping Country Code Required
1062
Invalid Shipping Country Code
1063
Invalid PurchaseItemsID
1064
Invalid GateWayID
1065
3D Secure failed
1066
3D Secure failed
1067
verifiedByVisaXID Required
1068
verifiedByVisaCAFF Required
support at support@mygate.co.za A Shipping Country Code was not specified. Please check that you have entered a Shipping Country Code. If this problem persists, please contact support at support@mygate.co.za An invalid Shipping Country Code was specified. A valid Shipping Country Code is expected - 2 alphabetical characters. If this problem persists, please contact support at support@mygate.co.za An invalid PurchaseItemsID was specified. If this problem persists, please contact support at support@mygate.co.za An invalid GateWayID was specified. If this problem persists, please contact support at support@mygate.co.za Cardholder enrolled, successful authentication, unsuccessful signature verification. If this problem persists, please contact support at support@mygate.co.za Cardholder enrolled, unsuccessful authentication, successful signature verification. If this problem persists, please contact support at support@mygate.co.za verifiedByVisaXID required when eCommerceIndicator = 05. If this problem persists, please contact support at support@mygate.co.za verifiedByVisaCAFF required when eCommerceIndicator = 05. If this problem persists, please contact support at support@mygate.co.za
2xxx = MyVirtual - Initiating Response Codes Code Message 2001 Invalid Gateway
2002
MerchantID does not exist
2003
ApplicationID does not exist
2004
TransactionIndex not found
Description The specified gateway is does not exist or is invalid. Please check that you have entered the correct gateway. If this problem persists, please contact support at support@mygate.co.za The specified merchant ID does not exist. Please check that you have entered the correct merchant id. If this problem persists, please contact support at support@mygate.co.za The specified Application ID does not exist. Please check that you have entered the correct Application ID. If this problem persists, please contact support at support@mygate.co.za The transaction index you specified does not exist. A valid transaction index must be specified in order to complete this transaction. If this problem
48
2005
Duplicate Merchant Reference
2006
Cant Credit without Debit
2007
ReverseAuthorisation Already Performed
2008
Debit Already Performed
2009
Credit Already Performed
2010
Authorisation Expected
2011
Debit Already performed
2012
Authorisation Already performed
2013
Budget must preceed transaction
2014
Authorise must preceed transaction
2015
Authorise must preceed transaction Refund must preceed transaction
2016
persists, please contact support at support@mygate.co.za A duplicate merchant reference was found. Your merchant reference must be unique. If this problem persists, please contact support at support@mygate.co.za A credit action cannot be implemented without a debit action on a transaction. If this problem persists, please contact support at support@mygate.co.za A ReverseAuthorisation action has already been implemented for this transaction. No more actions can be performed on this Transaction. If this problem persists, please contact support at support@mygate.co.za A Debit action has already been implemented for this transaction. A ReverseAuthorisation Action can no longer be performed on this transaction. If this problem persists, please contact support at support@mygate.co.za A Credit action has already been implemented for this transaction. No more actions can be performed on this Transaction. If this problem persists, please contact support at support@mygate.co.za Authorisation Action has not yet been performed. All transactions have to begin with an authorisation action. If this problem persists, please contact support at support@mygate.co.za A debit action has already been performed on this transaction. An action cannot be performed twice on the same transaction. If this problem persists, please contact support at support@mygate.co.za An authorisation action has already been performed on this transaction. An action cannot be performed twice on the same transaction. If this problem persists, please contact support at support@mygate.co.za Only a successful AUTHORISEPURCHASE and BUDGET can preceed a BUDGETREVERSAL. If this problem persists, please contact support at support@mygate.co.za Only a successful AUTHORISEREFUND can preceed a AUTHORISEREFUNDREVERSAL. If this problem persists, please contact support at support@mygate.co.za Only a successful AUTHORISEREFUND can preceed a REFUND. If this problem persists, please contact support at support@mygate.co.za Only a successful AUTHORISEREFUND and REFUND can preceed a REFUNDREVERSAL. If
49
2017
2018
2019
Refund must preceed transaction
this problem persists, please contact support at support@mygate.co.za Only a successful AUTHORISECASHADVANCE can preceed an AUTHORISECASHADVANCEREVERSAL. If this problem persists, please contact support at support@mygate.co.za Only a successful AUTHORISECASHADVANCE can preceed a CASHADVANCE. If this problem persists, please contact support at support@mygate.co.za Only a successful AUTHORISECASHADVANCE and CASHADVANCE can preceed a CASHADVANCEREVERSAL. If this problem persists, please contact support at support@mygate.co.za
2020
Incorrect Relationship
2021
Invalid Shipping Country Code
2050
Incorrect Decimal Length
An Incorrect Relationship with Gateway, Application and Merchant. The relationship between the given 3 values doesn't exist. If this problem persists, please contact support at support@mygate.co.za An invalid Shipping Country Code was specified. Please provide a valid shipping country code. If this problem persists, please contact support at support@mygate.co.za An incorrect amount of decimal places was passed. If this problem persists, please contact support at support@mygate.co.za
4xxx = MyVirtual - Security Response Codes Code 4001 Message Mode Denied Description This mode was denied. You cannot perform Live transactions until you have completed the test phase. Please contact support at support@mygate.co.za You cannot perform this transaction in the current mode. If you wish use test credit card numbers, please switch to test mode. If this problem persists, please contact support at support@mygate.co.za This merchant ID has not yet been enabled. If this problem persists, please contact support at support@mygate.co.za This merchant ID has been suspended. If this problem persists, please contact support at support@mygate.co.za This merchant ID has been removed. If this problem persists, please contact support at support@mygate.co.za
4002
Invalid Mode / Credit Card
4003
Merchant Inactive
4004
Merchant Suspended
4005
Merchant Removed
50
4006
Application Inactive
4007
Application Suspended
4008
Application Removed
This Application ID has not yet been enabled. Please contact support at support@mygate.co.za to be activated This application ID has been suspended. If this problem persists, please contact support at support@mygate.co.za This application ID has been removed. If this problem persists, please contact support at support@mygate.co.za The callers IP Address is not in the list of allowed IP Addresses for this Application. If this problem persists, please contact support at support@mygate.co.za The gateway that your trying to use, has been set to inactive. If this problem persists, please contact support at support@mygate.co.za The gateway that your trying to use, has been set to obsolete. If this problem persists, please contact support at support@mygate.co.za The currency you have specified is not listed under the allowed list of currencies for your application. You may only use ZAR as a currency. If this problem persists, please contact support at support@mygate.co.za The currency you have specified is invalid. If this problem persists, please contact support at support@mygate.co.za This transaction amount exceeds the transaction limit for your application. If this problem persists, please contact support at support@mygate.co.za This transaction amount exceeds the cumulative transaction limit for your application. If this problem persists, please contact support at support@mygate.co.za The card type you have specified is not listed under the allowed list of card types for your application. If this problem persists, please contact support at support@mygate.co.za The account type you have specified is not listed under the allowed list of account types for your application. If this problem persists, please contact support at support@mygate.co.za Budget transactions are not allowed for your application. If this problem persists, please contact support at support@mygate.co.za
4009
Source IP Address Invalid
4010
Gateway Inactive
4011
Gateway Obsolete
4012
Currency not allowed
4013
Invalid Currency
4014
Transaction Limit Exceeded
4015
Cumulative Transaction Limit Exceeded
4016
CardType not allowed
4017
AccountType not allowed
4018
Budget not allowed
5xxx = MyVirtual - Gateways Response Code Code 5001 Message Connection error to bank Description Error occurred because the Gateway havent been
51
5002 5003
Declined from the bank Unexpected Error
configured yet for live transactions The bank decline the transactions. See Appendix A Bank Response Codes An unexpected error occurred that was not provided for. Please notify MyGate immediately
6xxx = MyVirtual - Fraud Module Response Code Code 6001 Message Card Number Blacklisted Description Your card has been blacklisted on the payment gateway. If this problem persists, please contact support at support@mygate.co.za Your country code has been blacklisted on the payment gateway. If this problem persists, please contact support at support@mygate.co.za Your ip address has been blacklisted on the payment gateway. If this problem persists, please contact support at support@mygate.co.za Your unique client identifier has been blacklisted on the payment gateway. If this problem persists, please contact support at support@mygate.co.za The fraud module determined that this transaction was not safe for processing. This was determined by the Global IP Recognition Procedure. If this problem persists, please contact support at support@mygate.co.za The fraud module determined that this transaction was not safe for processing. This was determined by the Repeated Failure Identification Procedure. If this problem persists, please contact support at support@mygate.co.za The fraud module determined that this transaction was not safe for processing. This was determined by the Repeated Success Identification Procedure. If this problem persists, please contact support at support@mygate.co.za The fraud module determined that this transaction was not safe for processing. This was determined by the Unique Client Identifier Service Procedure. If this problem persists, please contact support at support@mygate.co.za
6002
Country Code Blacklisted
6003
IP Address Blacklisted
6004
UCI Blacklisted
6005
GIR Check Failed
6007
RFI Check Failed
6008
RSI Check Failed
6009
UCI Check Failed
8xxx = MyVirtual Warnings Codes Code 8001 8002 8003 8004 8005 8006 Message Mode was ignored Amount was ignored CCType was ignored CCNumber was ignored CCVNumber was ignored ExpiryMonth was ignored Description
52
8007 8008 8009
ExpiryYear was ignored Cumulative Transaction Limit Almost Exceeded Transaction Limit Exceeded
8010
Cumulative Transaction Limit Exceeded Transaction Index was ignored Currency was ignored Account Type was ignored Card Holder was ignored Budget was ignored Budget Period was ignored Cashback Amount was ignored Authorisation was ignored Flagged for Card Number Blacklist Flagged for Country Code Blacklist Flagged for IP Address Blacklist Flagged for UCI Blacklist Flagged for GIR Flagged for RFI Flagged for RSI Flagged for UCI Card Number Blacklist not performed Country Code Blacklist not performed IP Address Blacklist not performed UCI Blacklist not performed GIR not performed RFI not performed RSI not performed UCI not performed
You have exceeded your transaction limit. If this problem persists, please contact support at support@mygate.co.za You have exceeded your cumulative transaction limit. If this problem persists, please contact support at support@mygate.co.za
8011 8012 8013 8014 8015 8016 8017 8018 8029 8030 8031 8032 8033 8035 8036 8037 8038 8039 8040 8041 8042 8044 8045 8046
This transaction has been flagged by the Card Number Blacklist Procedure. This transaction has been flagged by the Country Code Blacklist Procedure. This transaction has been flagged by the IP Address Blacklist Procedure. This transaction has been flagged by the Unique Client Identifier Blacklist Procedure. This transaction has been flagged by the GIR Procedure. This transaction has been flagged by the RFI Procedure This transaction has been flagged by the RSI Procedure. This transaction has been flagged by the UCI Procedure. Card Number Blacklist procedure was not performed on this transaction Country Code Blacklist procedure was not performed on this transaction. IP Address Blacklist procedure was not performed on this transaction. Unique Client Identifier Blacklist procedure was not performed on this transaction. GIR procedure was not performed on this transaction. RFI procedure was not performed on this transaction. RSI procedure was not performed on this transaction. UCI procedure was not performed on this transaction.
53
8047
PurchaseItemsID Was Ignored
9xxx = MyVirtual - Unexpected Error 9001 Unexpected Error An unexpected error has occurred. Please try again later. If this problem persists, please contact support at support@mygate.co.za You requested functionality that has not been implemented on this gateway yet. If this problem persists, please contact support at support@mygate.co.za This card type has not yet been implemented on this gateway. If this problem persists, please contact support at support@mygate.co.za The fraud module returned an unexpected status. If this problem persists, please contact support at support@mygate.co.za The fraud module returned an unexpected result. If this problem persists, please contact support at support@mygate.co.za
9002
Request Not Implemented
9003
Card Type Not Implemented
9004
Fraud Status Unknown
9005
Fraud Result Unknown
1xx 2xx mimoney Error Codes An invalid voucher number was specified. A voucher number needs to be numeric and 18 characters in length. An invalid MSISDN number was specified. Please enter a valid MSISDN (Cell Number). An Invalid Account Number was specified. Please supply a valid account number. If this problem persists, please contact Support at support@mygate.co.za An invalid amount was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid card number was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid ID number was specified. If this problem persists, please contact Support at support@mygate.co.za An Invalid MerchantID was specified. If this problem persists, please contact Support at support@mygate.co.za
100 101 102
Invalid Voucher Number Invalid MSISDN Invalid Account Number
103
Invalid Amount
104
Invalid Card Number
105
Invalid ID Number
106
Invalid MerchantID
54
107 108 109
Invalid MSISDN Invalid PIN Invalid Purchase Data
An invalid MSISDN number (Cell Phone Number) was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid PIN was specified. If this problem persists, please contact Support at support@mygate.co.za Invalid Purchase Data was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid statement code was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid TerminalID was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid transaction reference was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid voucher action was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid voucher number was specified. If this problem persists, please contact Support at support@mygate.co.za The specified voucher is not in the correct state. If this problem persists, please contact Support at support@mygate.co.za An invalid voucher transaction reference was specified. If this problem persists, please contact Support at support@mygate.co.za An invalid voucher type was specified. If this problem persists, please contact Support at support@mygate.co.za An Application Error occurred. If this problem persists, please contact Support at support@mygate.co.za The mimoney accounting system was unable to process your transaction. If this problem persists, please contact Support at support@mygate.co.za The total value of the transaction exceeds that of your account limit. If this problem persists, please contact Support at support@mygate.co.za The transactional channel has been deactivated. If this problem persists, please contact Support at support@mygate.co.za The transactional channel password is invalid. If this
110
Invalid Statement Code
111
Invalid TerminalID
112
Invalid Transaction Reference
113
Invalid Voucher Action
114
Invalid Voucher Number
115
Invalid Voucher State Invalid Voucher Transaction reference Invalid Voucher Type Application Error Accounting System Unable to Find Payment Account Limit Reached
116
117 200 201
202
203 204
Channel Deactivated Channel Password Invalid
55
problem persists, please contact Support at support@mygate.co.za 205 Could Not Create Voucher Could Not Find Original Transaction Could Not Find Voucher Could Not Find Voucher Transaction The voucher could not be created at this time. If this problem persists, please contact Support at support@mygate.co.za The original transaction could not be found. If this problem persists, please contact Support at support@mygate.co.za The specified voucher could not be found. If this problem persists, please contact Support at support@mygate.co.za The specified voucher transaction could not be located. If this problem persists, please contact Support at support@mygate.co.za
206
207
208
209
The MSISND limit could not be set at this time. If this Could Not Load MSISDN Limit problem persists, please contact Support at support@mygate.co.za Could Not Load Payment Could Not Load Transaction Steps The payment could not be loaded. If this problem persists, please contact Support at support@mygate.co.za The transaction steps could not be loaded. If this problem persists, please contact Support at support@mygate.co.za
210
211
212
The transaction could not be locked for a reversal to Could Not Lock Transaction for occur. If this problem persists, please contact Support Reversal at support@mygate.co.za Could Not Obtain Voucher Lock Could Not Send Notification Could Not Unlock Transaction From Reversal Could Not Update Voucher Action Could Not Update Voucher at Transaction Close The voucher could not be locked. If this problem persists, please contact Support at support@mygate.co.za Notification could not be sent. If this problem persists, please contact Support at support@mygate.co.za The transaction could not be unlocked from the reversal. If this problem persists, please contact Support at support@mygate.co.za The voucher action could not be updated. If this problem persists, please contact Support at support@mygate.co.za The voucher could not be updated at transaction close. If this problem persists, please contact Support at support@mygate.co.za
213 214 215
216
217
218 219
The voucher PIN data could not be updated. If this Could Not Update Voucher PIN problem persists, please contact Support at Data support@mygate.co.za GI Technical Error A GI Technical Error occured. If this problem persists,
56
please contact Support at support@mygate.co.za 220 Incorrect Merchant An incorrect merchant was specified. If this problem persists, please contact Support at support@mygate.co.za An incorrect transaction was specified. If this problem persists, please contact Support at support@mygate.co.za An incorrect voucher PIN was specified. If this problem persists, please contact Support at support@mygate.co.za The voucher has insufficient funds for the transaction. If this problem persists, please contact Support at support@mygate.co.za The specified merchant is inactive. If this problem persists, please contact Support at support@mygate.co.za The merchant has reached their transactional limit. If this problem persists, please contact Support at support@mygate.co.za There is no issuer for the specified merchant. If this problem persists, please contact Support at support@mygate.co.za
221
Incorrect Transaction
222
Incorrect Voucher PIN
223
Insufficient Funds in Voucher
224
Merchant Inactive
225
Merchant Limit Reached
226
Merchant No Issuer
227
A TerminalID was not specified for the transaction. If Merchant TerminalID Required this problem persists, please contact Support at support@mygate.co.za Merchant Terminal Inactive Merchant Terminal Limit Reached Merchant Terminal Unknown The terminal specified is inactive. If this problem persists, please contact Support at support@mygate.co.za The transactional limit for the specified terminal has been reached. If this problem persists, please contact Support at support@mygate.co.za An unknown terminal was specified. If this problem persists, please contact Support at support@mygate.co.za An unknown merchant was specified. If this problem persists, please contact Support at support@mygate.co.za The voucher action specified was not found. If this problem persists, please contact Support at support@mygate.co.za The daily FICA limit for the specified MSISDN was reached. If this problem persists, please contact Support The monthly FICA limit for the specified MSISDN was
228
229
230
231
Merchant Unknown Merchant Voucher Action Not Found MSISDN Daily FICA Limit Reached MSISDN Monthly FICA Limit
232
233 234
57
Reached Original transaction Not Successful Payment Already Reversed Payment Error
reached. If this problem persists, please contact Support at support@mygate.co.za The original transaction was not successful. If this problem persists, please contact Support at support@mygate.co.za The transaction has already been reversed. If this problem persists, please contact Support at support@mygate.co.za A payment error has occured. If this problem persists, please contact Support at support@mygate.co.za
235
236 237 238
The PIN security requirements were not met. If this PIN Security Requirements Not problem persists, please contact Support at Met support@mygate.co.za Unable To End Voucher Transaction Unable To Move Fee Amount Unable To Move Principal Amount Unable To Move Profit Share Amount Unable To Move Service Fee Amount Unable To Move TransactionTax Amount Unable To Obtain Merchant Voucher Rate Unable To Obtain Voucher Details Unable To Obtain Voucher Quote Unable To Start Voucher Activation Unable To Start Voucher The transaction was unable to be completed. If this problem persists, please contact Support at support@mygate.co.za The fee amount could not be moved. If this problem persists, please contact Support at support@mygate.co.za The principal amount could not be moved. If this problem persists, please contact Support at support@mygate.co.za The profit share amount could not be moved. If this problem persists, please contact Support at support@mygate.co.za The service fee amount could not be moved. If this problem persists, please contact Support at support@mygate.co.za The transaction tax amount could not be moved. If this problem persists, please contact Support at support@mygate.co.za The merchant voucher rate was unable to be obtained. If this problem persists, please contact Support at support@mygate.co.za The voucher details could not be obtained. If this problem persists, please contact Support at support@mygate.co.za The voucher quote could not be obtained. If this problem persists, please contact Support at support@mygate.co.za Voucher activation could not be started. If this problem persists, please contact Support at support@mygate.co.za Voucher payment reversal could not be started. If this
239
240
241
242
243
244
245
246
247
248 249
58
Payment Reversal Unable To Start Voucher Purchase Unable To Start Voucher Redemption Unable To Start Voucher Status Change
problem persists, please contact Support at support@mygate.co.za Voucher purchase could not be started. If this problem persists, please contact Support at support@mygate.co.za Voucher redemption could not be started. If this problem persists, please contact Support at support@mygate.co.za The voucher status change could not be started. If this problem persists, please contact Support at support@mygate.co.za
250
251
252
253
An unknown fee calculation type was specified. If this Unknown Fee Calculation type problem persists, please contact Support at support@mygate.co.za Voucher Amount Below Minimum Limit Voucher Amount Exceeds Maximum Limit The specified amount is below the minimum limit. If this problem persists, please contact Support at support@mygate.co.za The specified amount exceeds the vouchers maximum limit. If this problem persists, please contact Support at support@mygate.co.za
254
255
256
The voucher cost exceeds the quoted value. If this Voucher Cost Exceeds Quoted problem persists, please contact Support at Value support@mygate.co.za Voucher Number Generation Failure Voucher PIN Locked The voucher number could not be generated. If this problem persists, please contact Support at support@mygate.co.za The PIN for the specified voucher has been locked. If this problem persists, please contact Support at support@mygate.co.za
257
258
259
The specified change in voucher is invalid. If this Voucher Status Change Invalid problem persists, please contact Support at support@mygate.co.za Voucher Status Is Inactive Voucher Status Is Cancelled Voucher Status Is Creating The voucher specified is inactive. If this problem persists, please contact Support at support@mygate.co.za The voucher specified is cancelled. The specified voucher is being created. If this problem persists, please contact Support at support@mygate.co.za The specified voucher has expired. If this problem persists, please contact Support at support@mygate.co.za The specified voucher is pending activation. If this problem persists, please contact Support at
260 261 262
263 264
Voucher Status Is Expired Voucher Status Is Pending Activation
59
support@mygate.co.za 265 Voucher Status Is Redeemed Or Depleted Voucher Status Is Suspended The specified voucher is redeemed or depleted. If this problem persists, please contact Support at support@mygate.co.za The specified voucher is suspended. If this problem persists, please contact Support at support@mygate.co.za The specified voucher status is undefined. If this problem persists, please contact Support at support@mygate.co.za The specified transaction is in the incorrect state. If this problem persists, please contact Support at support@mygate.co.za The specified trnasaction is too old to be re-processed. If this problem persists, please contact Support at support@mygate.co.za There is a mismatch with the MSISDN. If this problem persists, please contact Support at support@mygate.co.za The workflow version is unknown. If this problem persists, please contact Support at support@mygate.co.za The voucher could not be grouped. If this problem persists, please contact Support at support@mygate.co.za The voucher could not be grouped for reversal. If this problem persists, please contact Support at support@mygate.co.za A reversal on the specified voucher is not permitted. If this problem persists, please contact Support at support@mygate.co.za The specified Merchant does not exist on the MiMoney database. If this problem persists, please contact support.
266
267
Voucher Status Is Undefined VoucherTransaction In Incorrect State Voucher Transaction Too Old
268
269
270
MSISDN Mismatch
271
Unknown Workflow Version Unable To Start Voucher Grouping Unable To Start Voucher Grouping Reversal Voucher Payment Reversal Illegal Merchant does not exist
272
273
274
275
60

Myvirtual Userguide

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Myvirtual Userguide

Uploaded by

Copyright:

Available Formats

Virtual API

Merchant User Guide

MyGates role in the transaction process:

Website Orders Payment Gateway

MyGate Payment Solutions:

Credit Card Processing:

Cell Pay Point:

The MyGate Web Console:

The MyGate Fraud Module:

Credit Card Processing:

Variable Name Mode txtMerchantID

Required Yes Yes

Your Application UID allocated by MyGate

3 Letters as specified in ISO4217 (e.g. ZAR).

AlphaNumeric (MaxLength: 128)

AlphaNumeric, representing the users IP Address eg 172.16.32.182

AlphaNumeric (MaxLength: 256)

txtItemDescr txtItemAmount txtShippingCost txtDiscount txtRecipient

txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5 txtQty txtItemRef

txtShippingCost txtDiscount Variable1, Variable2, Variable3, etc

AlphaNumeric (MaxLength: 128) e.g. Black Plasma

Shopping-Cart Variables that can be posted to MyGate:

MyVirtual HTML Code Example:

MyVirtual Shopping Cart Code Example:

RCCB Variables to Be Posted To MyGate:

Numeric with 2 decimal places e.g. 150.00

AlphaNumeric (MaxLength: 64) e.g Joe Soap

AlphaNumeric (MaxLength: 64) e.g. Acc123043

Text e.g. test@mydomain.co.za Boolean e.g.: 0 = No 1 = Yes

Text e.g. 0830000000

Boolean e.g: 0 = No 1 = Yes

Text e.g. Recurring Billing

Text e.g. Recurring Frequency

Text e.g. Recurring Amount

Boolean e.g. 0 = No 1 = Yes

Boolean e.g. 0 = No 1 = Yes

Boolean e.g. 0 = No 1 = Yes

Boolean e.g. 0 = No 1 = Yes

Boolean e.g. 0 = No 1 = Yes

RCCB HTML Code Example:

Cell Pay Point Integration:

Variable Name txtMode

txtMerchantStatementR ef txtCustomerStatement Ref txtPrice

AlphaNumeric (20 chars max)

AlphaNumeric (20 chars max)

3 Letters as specified in ISO4217 (e.g. ZAR)

A fully qualified URL (e.g. http://www.mygate.co.za/succe

txtRecipient txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5 txtQty txtItemRef

txtItemAmount txtShippingCost txtDiscount Variable1, Variable2, Variable3, etc

HTML example core requirements

HTML example when send through shopping cart details

xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx (where x is a hexadecimal number) AlphaNumeric

txtCurrencyCode txtRedirectSuccessfulU RL txtRedirectFailedURL

txtItemCode1, txtItemCode2 etc.

txtItemName1, txtItemName2 etc.

txtUnitCount1, txtUnitCount2 etc. txtUnitCost1, txtUnitCost2 etc.

A numeric value A numeric value

A numeric value (0 for no discount)

A numeric value (0 for no discount)

eBucks HTML Example:

txtCurrencyCode txtRedirectSuccessfulU RL txtRedirectFailedURL

txtRecipient txtShippingAddress1 txtShippingAddress2 txtShippingAddress3 txtShippingAddress4 txtShippingAddress5

txtItemAmount txtShippingCost txtDiscount Variable1, Variable2, Variable3, etc