Created : 15 April 2015
Last Modified : 12 June 2018

***********************************************************************************
Contents:

A. SUMMARY
B. FILE STRUCTURE
C. INSTALLATION INSTRUCTION
D. CHANGES
E. CONFIGURATION SETTINGS
F. DATABASE TABLES MODIFIED
G. LANGUAGE SETTINGS CHANGED
H. CHANGE LOGS
I. TROUBLESHOOTING
J. FAQ
K. COPYRIGHT NOTICE
L. TERMS AND CONDITIONS
***********************************************************************************

A. SUMMARY
==========

This interface is for use with QuickBooks Payment Gateway
Dedicated SSL Certificate is required.

***********************************************************************************

B. FILE STRUCTURE
===================

Files included in the zip are:
Refer to the package

***********************************************************************************

C. INSTALLATION INSTRUCTION
============================

1. Upload all the files into your shopping cart folder.

2. Log into super admin and execute setup file, eg: http://www.yourdomain.com/yourshoppingcartfolder/youradminfolder/quickbookspg_setup.asp

3. After setup the module, would be redirected Module configuration page for configure the module

HOW TO REGISTER AND GET CONNECTION TICKET
-----------------------------------------
1. Register a QBMS Merchant A/C by browsing https://merchant.intuit.com/signup/start.wsp
2. Get a Connection Ticket
A. Please open https://merchantaccount.quickbooks.com/j/sdkconnection?appid=xxx&sessionEnabled=false
i. where xxx is your Application ID.
B. Log in with your Merchant Email Login and Password
C. Click "Create a New Connection Ticket"
D. "Turn on login security?" - set to "No"
E. Replace "xxx" of x_ConnectionTicket at quickbookspgshopcheckout.asp with your newly created Connection Ticket

PAYMENT NOTIFICATION
--------------------
1. For Approval,
ocardtype
QuickBooks
oauthorisation
QuickBooks 0 : 0<br>Transaction ID=<Transaction ID><br>Approval Number=<Approval Number>
<br>AVS Address=<AVS Address Status><br>AVS Zip=<AVS Zip Status><br>CVN=<CVN Status>

2. For Declined transaction,
ocardtype
QuickBooks-Declined
oauthorisation
The reason why the transaction was declined.

TROUBLESHOOTING
---------------
1. Why does the transaction fail?
A. QBMSXML/SignonMsgsRs/SignonDesktopRs/@statusCode (which is statuscode of session) return a non-zero value.
2000 : Authentication failed -- Invalid login name or password / certificate / ticket
2010 : Unauthorized
2020 : Session Authentication required
2030 : Unsupported signon version
2040 : Internal error

Please check your Application Login, Connection Ticket and Application ID.

B. QBMSXML/QBMSXMLMsgsRs/CustomerCreditCardChargeRs/@statusCode (which is statuscode of card info) return a non-zero value.
10501 : A general system error.
or
Please check your Card Info and Transaction Amount.

2. I'm getting a credit card number length error even though I've entered the correct credit card numbers

A. This generally happens because xEncryptCreditCards is enabled on the shop administration. Some server have problem with this feature
especially if you are not hosted on a Windows server. There is no need to enable this option if you are not using shopcheckout.asp
or sslshopcheckout.asp since the Quickbook gateway does not save the credit card details to the database.

Simply disable xEncryptCreditCards on the administration page and this should resolve the issue.


***********************************************************************************

D. CHANGES
===============

NONE

***********************************************************************************

E. CONFIGURATION SETTINGS
=================

NONE


F. DATABASE TABLES MODIFIED
===========================

NONE

***********************************************************************************

G. LANGUAGE SETTINGS CHANGED
============================

NONE

***********************************************************************************

H. CHANGE LOGS
============================

2016.02.25 - XML: To support TLS1.2
2018.01.20 - Added mandatory parameter IsECommerce and IsMobile
2018.04.18 - Compatible with v9
2018.06.12 - Validate card fields first before submitting to quickbooks

***********************************************************************************

I. TROUBLESHOOTING
============================

Please submit a ticket to our helpdesk at https://helpdesk.vpcart.com and our support team will assist you.

***********************************************************************************

J. FAQ
============================

NONE

***********************************************************************************
K. COPYRIGHT NOTICE
============================

Copyright (c) 1999-2019 Rocksalt International Pty. Ltd.
All rights reserved.

This software and documentation constitute a published work and
contains valuable trade secrets and proprietary information
belonging to Rocksalt International Pty. Ltd. .
None of the foregoing material may be copied,
duplicated or disclosed without the express written permission
of Rocksalt International Pty. Ltd. .

LICENSEE ACCEPTS VP-ASP Shopping Cart "AS IS" "WITH ALL FAULTS",
Rocksalt International Pty. Ltd. accepts no responsibility for the
operation or performance of the VP-ASP Shopping Cart.
The entire risk of use and consequences of use of the
VP-ASP Shopping Cart falls completely on the Licensee
and Rocksalt International Pty. Ltd. shall not be liable in any respect
for any claims, loss or injury alleged to have resulted
from use of or in reliance on VP-ASP Shopping Cart.

Licensee acknowledges that it has read the foregoing
disclaimers of warranty and limitation of liability
and understands that Licensee assumes
the entire risk of using VP-ASP Shopping Cart.


***********************************************************************************

L. TERMS AND CONDITIONS
============================
ROCKSALT INTERNATIONAL GRANTS TO THE LICENSEE A NON-EXCLUSIVE,
NON-SUB LICENSABLE, NONTRANSFERABLE LICENSE
TO INSTALL AND USE THIS APPLICATION ON A SINGLE DOMAIN FOR
A SINGLE SHOP.

THE CODE IN THE APPLICATION MAY BE MODIFIED FOR USE IN
SETTING UP A SINGLE SHOPPING SITE ON THE WORLD WIDE WEB.

LICENSEE MAY MAKE A COPY OF THE APPLICATION FOR
BACK-UP AND ARCHIVAL PURPOSES, PROVIDED THAT ANY COPY
MUST CONTAIN ALL PROPRIETARY NOTICES INCLUDED
WITH THE APPLICATION.

LICENSEE IS PROHIBITED FROM SELLING OR DISTRIBUTING
THE APPLICATION IN ANY MANNER.

LIMITATION OF LIABILITY.

ROCKSALT INTERNATIONAL AND ITS LICENSORS SHALL
NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE OR ANY
THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING THIS
APPLICATION.

IN NO EVENT WILL ROCKSALT INTERNATIONAL OR ITS LICENSORS
BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA,
OR FOR DIRECT, INDIRECT, SPECIAL,
CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES,
HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LI
ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE,
EVEN IF ROCKSALT INTERNATIONAL HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.