This guide shows you how to connect BlueSnap and Magento to build a unified shopping cart and payment solution.
To integrate to Magento 2.1, click here.
Before you begin
Make sure you have finished preparing your BlueSnap account for a shopping cart integration before you begin.
BlueSnap requires that jQuery is installed in your Magento account in order to run transactions successfully. If you do not already have jQuery installed as part of an existing plugin or extension, select Yes next to Include jQuery library when you configure your BlueSnap plugin. See Setup Steps.
- Setup Steps
- API Logger
- Capturing Payments
- Reordering on Behalf of a Shopper
- Supporting One-Step Checkout
Download the BlueSnap plugin from GitHub as a ZIP.
Unzip the folder.
Copy the folder into your store root directory using your FTP.
Check that you have a current backup of your site or create one by going into System > Tools > Backup.
Disable compilations via System > Tools > Compilations.
To clear cache, go to System > Cache Management, select all the files in the list, choose the refresh option in the dropdown menu, and click Submit.
Log out of your admin panel, and log back in.
To confirm that the upload went smoothly, go to Advanced > Developer in your admin panel, and under disable modules output, check that your newly installed plugin is in the list.
After installing the plugin, configure it as follows:
In the Magento admin panel, go to System > Configuration.
In the left menu, go to Sales > BlueSnap.
Configure the following settings. When you are done, click Save Config.
- Sandbox Mode: Select No to work with your BlueSnap production account, or Yes to work with your BlueSnap sandbox account. You should set this to No once you are ready to go live.
- Is Debug Mode Enabled: You may want to select Yes when you are initially using the plugin, so that the IPN data will be saved in the file server. This information can be useful for troubleshooting purposes.
- Is DryRun Mode Enabled: Select No.
- Display Base Currency to Customer: Select Yes.
- Include jQuery library: In order for the BlueSnap plugin to work properly, you must have jQuery installed. If you do not already have jQuery installed as part of an existing plugin or extension, select Yes to have it installed with the BlueSnap plugin.
- Merchant ID: Enter the Merchant ID you obtained when setting up your BlueSnap account.
- Store ID: Enter the Store ID you obtained when setting up your BlueSnap account.
- API Username: Enter the your BlueSnap API username.
- API Password: Enter the BlueSnap API password.
- Data Protection Key: Enter your BlueSnap Data Protection Key.
- Magento Order Contract ID: Enter the Contract ID you obtained when setting up your BlueSnap account.
- CSE Public Key: Enter the CSE Key you obtained when setting up your BlueSnap account.
Finding your BlueSnap settings
You can find your BlueSnap API credentials, store ID, contract ID, data protection key, and CSE key in the BlueSnap Merchant Console. For instructions, see Preparing your BlueSnap account for a shopping cart.
In the left menu, go to Sales > Payment Methods. You will see a list of the available payment methods and providers.
Ensure that the Saved CC option is disabled. This is a different plugin offered by Magento which could conflict with BlueSnap card payments. You can have the others enabled (e.g. PayPal, Bank Transfer, Cash on Delivery), but please note these are not handled by BlueSnap.
In the BlueSnap Credit/Debit Card section, configure the following settings. When you are done, click Save Config.
- Enabled: Select Yes. This means that BlueSnap card payments will appear as an option during checkout.
- Title: This is how the payment method option will be displayed to your shoppers.
- Payment Action: If you sell digital goods or products that are in stock and ready to be shipped immediately after purchase, we recommend you select Authorize and Capture. Payment will take place right away. If you will deliver your products at a later date, you may want to select Authorize Only. This will only run an authorization on the card, but won’t take the payment. If you are only authorizing the orders, go to Capturing Payments to learn how to capture the orders later.
BlueSnap requires a secure connection to process payments.
Please complete these two requirements:
Install SSL on your server.
In Magento, in the System menu, go to Configuration > Web > HTTPs config.
In the Secure section, configure the following:
- Set Use secure URLs in Front End and Use secure URLs in Admin both to Yes when you are ready to move to production. While testing in Sandbox mode, these two fields can be set to No.
- Ensure that the Base URL starts with https://
In Magento, in the System menu, go to Configuration > Currency Setup.
In the Allowed currencies menu, select the currencies for display. The shopper will still be charged in the store’s base currency.
Under Scheduled Import Settings, set it to enabled and select the BlueSnap service. This is required for currency conversion and for automatic updates of BlueSnap exchange rates.
To view and manage currency rates, go to System > Manage Currency > Rates. If you want to manually update rates, make sure that your import service is BlueSnap.
Recommended: multiple stores/websites per currency/language
If you wish to charge shoppers in different currencies, Magento recommends that you set up different websites or stores per currency.
You can add a new website/store under System > Manage stores. Once you have created a new store, you can go to System > Configuration > Currency service, choose the website from the top left dropdown, and select the currency for the second store.
The API logger is a useful tool for developers, particularly for troubleshooting.
You can set this up to get an alert when an API call fails, define the email address where the alert should be sent, and choose the template for the alert.
If you want to record API call logs, you can set the Save logs period (days) to 90. Note: Significantly Increasing the number of days may result in heavy memory usage and plugin instability.
To capture a payment that has been authorized:
Go to Sales > Orders.
Under BlueSnap Reference Number, you will see an Order ID (if the transaction is still pending capture) or an Invoice ID if the transaction has already been processed (captured).
Click View next to the relevant order.
Click Invoice > Capture online > Submit Invoice. The invoice is created, and when you go back to the orders list, an invoice number will now appear for that order.
With your admin account, you are able to re-order on behalf of a shopper. This is useful if a shopper experiences technical difficulties.
On the order page (Sales > Orders), a Reorder button will appear, and the BlueSnap payment method will be available. The card and billing details used for this payment will be added to this customer’s account. You should only use payment methods that belong to the shopper.
Note that the reorder option is available only for “registered” users, or users with an account. It is not available for shoppers who previously checked out as a “guest”.
This section should also be secured with an SSL certificate.
One-step checkout allows shoppers to check out in a single page or step, rather than the default multi-step checkout flow. The BlueSnap plugin has been verified to work with the following one-step checkout extensions:
- IWD Magento One-page Checkout (free)
- aheadWorks One-Step Checkout (paid)
Other one-step checkout extensions may also work, but have not been specifically verified.
Here is an example of a one-step checkout page as the shopper would see it: