

Magento provides a flexible, e-commerce platform on which merchants can create and manage their online store. By connecting to BlueSnap, you can securely process global credit and debit card payments right from your checkout page; shoppers never have to leave your site. Additionally, you can take advantage of BlueSnap’s comprehensive reporting capabilities to better understand your business.
Supported features
3-D Secure
Auth/Capture and Separate Auth and Capture
Chargeback Management
Fraud Prevention
Built-in Fraud Prevention and Risk Management
Enhanced fraud using Device Data Collector
Hosted Payment Fields
Multiple Currencies and Multiple Languages
Partner Sandbox Testing
Payment Analytics and Reporting
Payment Methods: Apple Pay, Credit/Debit Cards, and Splitit
Payment Optimization
Vaulted Shoppers
Requirements
This BlueSnap extension is supported in the following versions:
- Magento 2.2.x and 2.3.x Commerce (formerly Enterprise)
- Magento 2.2.x and 2.3.x Opensource (formerly Community)
(To integrate to Magento 1, click here.)
Magento and BlueSnap accounts
You must have accounts at both Magento and BlueSnap to proceed.
If you need a Magento account, go to the Magento website to sign up.
If you need a BlueSnap account, go to the BlueSnap website to get started.
Magento software
This guide assumes that you already have the Magento software installed and uploaded to your server. For Magento's system requirements, refer to the Magento documentation.
HTTPS configuration
BlueSnap requires a secure connection to process payments. You must ensure that your domain is SSL certified and SSL is enabled for Magento. (Step 4: Enable SSL explains how.)
Supported currencies
BlueSnap supports the currencies listed here. We recommend configuring your store to only accept currencies supported by BlueSnap.
Supported countries
BlueSnap supports the countries listed here. If a shopper is located in one of these supported countries, they will be able to purchase with the BlueSnap payment module.
PCI compliance
A PCI compliance of SAQ-A is required.
Step 1: Configure your BlueSnap account settings
Before you install the BlueSnap extension in Magento, complete these steps in your BlueSnap Console for production or sandbox.
-
Get your BlueSnap API credentials and define the authorized IP addresses for your server production environment to be used for API calls. Both of these actions are performed on the same page; for instructions click here.
-
To get paid, you need to configure your payout settings. Refer to Payout for more information.
Step 2: Install and upload the BlueSnap extension
The BlueSnap extension is available free from Magento.
-
Download the BlueSnap extension file to your machine.
-
In the
app/cide
directory of your Magento installation, create aBlueSnap
directory and create aPayment
directory in theBlueSnap
directory . -
Upload the BlueSnap extension file to the
.../app/cide/BlueSnap/Payment
directory you just created. You can use an FTP client such as FileZilla, or an SSH client such as PuTTY, using your server permissions. -
Extract the file by running the following command from the command line on your server, replacing
file_name
with the name of the file.
tar xzvf file_name.zip --strip 1
-
For Magento to recognize the BlueSnap extension, you must run the following upgrade command from the root folder:
bin/magento setup:upgrade
Note: If you have difficulty running this command, make sure that your
bin/magento
executable has execute permissions. -
If you are not running your Magento installation in compiled mode, skip to step 7. If you are running in compiled mode, complete this step:
- Recompile the Magento code by typing the following command from the root folder:
bin/magento setup:di:compile
Note: This process may take a few minutes.
- To generate static content in production mode, complete this step:
- Run the following command from the root folder of your Magento installation, replacing the locales at the end with what is appropriate for your store.
bin/magento setup:static-content:deploy en_GB en_US
- To see the full list of ISO-636 language codes, run:
magento info:language:list
.
- If you have Magento caching enabled, log in to your Magento store as an admin, go to System > Cache Management, and click Flush Magento Cache.
Step 3. Configure the BlueSnap extension
To configure the BlueSnap Extension, you must be logged in to your store as an admin.
-
Go to Stores > Configuration > Sales > Payment Methods. If the installation was successful, you see the new BlueSnap Credit/Debit Card Payments section. Click this section to expand it.
-
Configure the following settings.
Setting | Description |
---|---|
Enable this Solution | Select Yes to enable the BlueSnap extension. This means that BlueSnap appears as a payment option during checkout. |
Enable Vaulted Shoppers |
|
IPN Configuration | Copy the URL from this section and use it for the IPN Setup section below. |
Enable 3D secure |
|
Enable Apple Pay |
|
Enable Dynamic Currency Conversion (DCC) | Shoppers can always choose the displayed currency. This setting determines the currency for the actual charge.
|
Mode |
|
Payment Action |
|
Soft Descriptor | Enter a string, no more than 20 characters in length. This descriptor appears on the shopper's billing statement to help them identify the purchase.
|
Sort Order | Enter an integer to alter the positioning of the BlueSnap payment method above or below other methods. The payment method with the smallest sort order appears at the top of the checkout form. |
Title | By default, this field displays Credit/Debit Cards. This label is displayed to the shopper when they choose a payment option during checkout. |
Payment from Applicable Countries |
|
Payment from Specific Countries | If Specific Countries was selected, then this section is applicable. Select the shipping countries for which you want BlueSnap to be an available payment method.
|
BlueSnap Seller ID | Enter your merchant ID number from your BlueSnap merchant account. |
API Username (Sandbox) and | Enter your API Username and Password for your BlueSnap sandbox account. |
API Username (Production) and | Enter your API Username and Password for your BlueSnap production account.
|
Debug |
|
Error Email Recipient | Enter an email address to which messages are sent if a transaction error occurs. |
IPN IP Whitelist (Sandbox) | By default, this field contains IP addresses from which you receive IPN/webhooks keeping you informed of activity in your sandbox account.
|
IPN IP Whitelist (Production) | By default, this field contains IP addresses from which you receive IPN/webhooks keeping you informed of activity in your production account.
|
-
Click Save Config.
-
If you have Magento caching enabled, log in to your Magento store as an admin, go to System > Cache Management, and click Flush Magento Cache.
Step 4. Enable SSL
BlueSnap requires a secure connection to process payments. Complete the following steps:
-
Install SSL on your server.
-
Log in to your Magento store as an admin and go to Stores > Configuration > General > Web.
-
In the Base URLs (Secure) section, configure the following:
- Ensure that the Secure Base URL starts with:
https://
- For Use secure URLs on Storefront and Use secure URLs in Admin, clear the Use system value checkbox, and set each to Yes.
- Click Save Config.
Step 5. Currency configuration
-
Log in to your Magento store as an admin and go to Stores > Configuration > General > Currency Setup.
-
Set the following:
- Base Currency
- Default Display Currency
- Allowed Currencies — Only choose currencies supported by BlueSnap.
-
Click Save Config.
-
If you have Magento caching enabled, go to System > Cache Management, and click Flush Magento Cache.
-
Go to Stores > Currency Rates.
-
In the Import Service box, select BlueSnap. This lets you import the BlueSnap currency rates.
-
Click Import.
The table shows the currency conversion rates. -
Click Save Currency Rates.
-
If you have Magento caching enabled, go to System > Cache Management, and click Flush Magento Cache.
Step 6. IPN Setup
Instant Payment Notifications (IPNs) are webhooks that trigger an HTTP POST message to your Magento account when an important event occurs. Follow the steps below to set up IPNs.
-
Log in to your BlueSnap account and go to Settings > General Settings.
-
In the Notifications section, select Receive Instant Payment Notifications.
-
Update the IPN URL(s) field. The format of the URL should follow this pattern:
https://www.yourdomain.com/bluesnap/ipn/index
-
Click Submit.
For more information on IPNs, refer to our IPN documentation.
Capture Payments
To capture a payment that has been authorized, follow the steps below.
Note: Manually capturing transactions is relevant when the Payment Action is set to Authorize Only in the BlueSnap Configuration.
-
In your Magento store admin account, go to Sales > Orders.
-
Click View next to the relevant order.
-
On the top menu bar, click Invoice and scroll to the bottom of the page where you see a drop-down list; choose Capture Online from this list.
-
Click Submit Invoice.
Updated 8 months ago