VPCart 9.0 Bambora Hosted Payment Form gateway Readme

Created : 21 April 2018
Last Modified : 29 June 2018

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

A. SUMMARY
B. FILE STRUCTURE
C. INSTALLATION INSTRUCTION
D. HOW IT WORKS
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 Bambora Hosted Payment Gateway (previously known as Beanstream Hosted).
It is supporting credit card payment.

This payment gateway is supporting normal checkout and onepage checkout.

To use this module, you must register an account first with Bambora. More info at: www.bambora.com

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

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

Files included in the zip are:
- $READ_ME_FIRST_bamborahosted900.HTML
- bamborahosted_execute.asp
- bamborahosted_process.asp
- bamborahostedaccept.asp
- bamborahostedconfig.asp
- bamborahosteddecline.asp
- bamborahostedgateway.asp
- bamborahostedmd5.asp
- bamborahostedsha1.asp
- admin/bamborahosted_setup.asp
- admin/bamborahosted_setup_config.asp
- admin/bamborahosted_setup_process.asp
- admin/sqlscripts/bamborahosted/*

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

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

1. Upload the below files to your VPCart 9.00 root folder.
- bamborahosted_execute.asp
- bamborahosted_process.asp
- bamborahostedaccept.asp
- bamborahostedconfig.asp
- bamborahosteddecline.asp
- bamborahostedgateway.asp
- bamborahostedmd5.asp
- bamborahostedsha1.asp

2. Upload the below files to your ADMIN folder. If you have renamed your ADMIN folder, then this must be placed in the renamed folder.
- admin/bamborahosted_setup.asp
- admin/bamborahosted_setup_config.asp
- admin/bamborahosted_setup_process.asp
- admin/sqlscripts/bamborahosted/*

3. Log into super admin and execute page below:
http://www.yourdomain.com/<your admin folder>/bamborahosted_setup.asp

Note: Replace the below with your VPCart site
{ www.yourdomain.com } : your site domain
{ your admin folder } : your admin folder

Click Install Now button.

4. After installation completed, you should see message below:
_______________________________________________________
The Bambora Hosted Payment solution initial setup has now been completed.

Please go to modules configuration page for further setup.
_______________________________________________________

5. Please click the "modules configuration page" link to setup.

- Enable? : Set to Yes to enable Bambora Hosted Payment gateway.

- Merchant ID: Please enter your Bambora merchant ID.

NOTE :
To get your merchant ID, please follow these steps :
- Login to your Bambora merchant at : https://web.na.bambora.com/admin/sDefault.asp
- Your merchant ID should be located in the top right section.

- Gateway URL: Bambora web service URL. Default is https://web.na.bambora.com/scripts/payment/payment.asp

- Transaction Type: Indicates the Transaction Type. Default is P.
Enter P for Purchase
Enter PA for Pre-auth.

- Hash algorithm: Available value: MD5 or SHA-1.
NOTE :
You need to enter Hash Algorithm if your Bambora account is enabled for Hash Validation.
This must match the Hash Algorithm that you selected in your Bambora account setting.
Please refer to https://help.na.bambora.com/hc/en-us/articles/360001530528-Enabling-Hash-Validation on how to enable your account for Hash Validation.

- Hash key: Enter your Hash Key.
NOTE :
You need to enter Hash Key if your Bambora account is enabled for Hash Validation.
This must match the Hash Key that you have entered in your Bambora account setting.
Please refer to https://help.na.bambora.com/hc/en-us/articles/360001530528-Enabling-Hash-Validation on how to enable your account for Hash Validation.

- API access passcode : Enter your API access passcode .
NOTE :
You need to enter API access passcode if your Bambora account is enabled for API access passcode.
This must match the API access passcode that you have entered in your Bambora account setting.
Please refer to https://help.na.bambora.com/hc/en-us/articles/360001533087-Enabling-Passcode on how to enter API access passcode for your account.

Click Save button.

6. You are done.

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

D. HOW IT WORKS
===============

After you have installed Bambora Hosted payment gateway module, when customers do a checkout, they will see a button "Click here to Pay" on the checkout page. When it is clicked, customers will be redirected to Bambora site to enter their card.

Once payment is made on Bambora site, customers will be returned back to the merchant site.

If it is a success payment, then Bambora will return customers to bamborahostedaccept.asp page.

On this page, VPCart will update the following Orders table fields as below eg :
ocardtype : Bambora
oauthorisation : Approved - Auth Code=[authorization code]

Then the page bamborahostedaccept.asp will redirect customers to shopthanks.asp which is the final order page.

If it is a declined/failed payment, then Bambora will return customers to bamborahosteddecline.asp page.

On this page, VPCart will update the following Orders table fields as below eg :
ocardtype : Bambora-Declined
oauthorisation : [error message]

Then the page bamborahosteddecline.asp will redirect customers back to shopcheckout.asp.asp to retry their payment.

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

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

New configs:
xbambora_enable
xbambora_GATEWAY_URL
xbambora_merchant_id
xbambora_TRANS_TYPE
xbambora_HASH_TYPE
xbambora_HASH_VALUE
xbambora_PASSCODE

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

NONE

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

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

NONE

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

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

2018.05.08 - Better error handling for onepage checkout.
2018.06.20 - Security protection - Hash Validation.
2018.06.29 - Security protection - API Access Passcode.

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

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-2023 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.