Magento 2 Setup

Learn how to connect your Magento 2 account to BlueSnap for a unified shopping cart and payment gateway solution.

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.

Requirements

This BlueSnap extension is supported in Magento versions Community 2.1.3 and Enterprise 2.2.3.

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 for Community 2.1.3 or Enterprise 2.2.3 installed and uploaded to your server.

For Magento's system requirements, click here.
For software installation instructions, click here.

HTTPS configuration

BlueSnap requires a secure connection to process payments. You'll need to ensure that your domain is SSL certified and SSL is enabled for Magento (Step 4: Enable SSL walks you through how to do this).

Supported currencies

BlueSnap supports the currencies listed here. If a shopper chooses a currency not shown on this list, BlueSnap payments are not available.

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 account:

  1. Set up your BlueSnap API Credentials and define the authorized IP address for your server. Make note of your API username and password - you'll need them in later steps.

  2. Configure your payout settings.

Step 2: Install and upload the BlueSnap extension

The BlueSnap extension is available for free from Magento.

  1. Download the BlueSnap extension file to your machine.

  2. Upload the BlueSnap extension file to the root folder of the Magento installation on your server. In most cases this is .../app/code/Bluesnap/Payment. You can use use an FTP client such as FileZilla, or an SSH client such as PuTTY, using your server permissions.

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

  4. In order for Magento to recognize the existence of the BlueSnap extension, you'll need to 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.
  5. If you are running your Magento installation in compiled mode, complete this step. If not, skip to step 6.

    • 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.
  6. In order 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
    • Too see the full list of ISO-636 language codes, you can run:
      magento info:language:list.
  7. If you have Magento caching enabled, complete this step, as you'll need to flush the caches after installation.

    • Log into your 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 need to be logged into your store as an admin.

  1. Go to Stores > Configuration > Sales > Payment Methods. If the installation was successful, you'll see the new BlueSnap section. Click on this section to expand it.
  1. Configure the following settings. When you are done, click Save Config.
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

  • Select Yes to allow logged-in shoppers the option to store their credit card details for future purchases. They can manage their information from their My Account area.

  • Select No to disable this option.



Enable Dynamic Currency Conversion (DCC)

  • Select Yes to allow shoppers the option to select their preferred currency (of the available store currencies) from a drop down box during checkout. If they select a different currency, they see the converted value that they will be charged.

  • Select No to disable this option, meaning that shoppers cannot change the currency during checkout.



Mode

  • Select Sandbox to work with your BlueSnap sandbox account for testing purposes.

  • Select Production to work with your BlueSnap production account.

Note: You should set this field to Production once you are ready to start accepting live transactions.



Payment Action

  • Select Authorize Only to only run an authorization on the card to make sure it has enough available credit (payment is not taken right away). We recommend that you use this option if you'll deliver your products at a later date. See Capture Payments to learn how to manually capture the order payment later.

  • Select Authorize and Capture to authorize a transaction and capture the payment in the same step. We recommend you use this option if you sell digital goods or products that are in stock and are ready to be shipped immediately after purchase.



Title

By default, this field displays Credit/Debit Cards. This label is displayed to the shopper when they choose a payment option during checkout.



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.

Note: Do not use BLS* in your soft descriptor; the asterisk (*) is an unrecognized character in Magento.



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.



Payment from Applicable Countries

  • Select Allowed Countries to allow BlueSnap to be displayed as a payment option for any country that is configured in Magento.

  • Select Specific Countries to restrict the BlueSnap payment method to be available to only a specified list of shopper shipping countries. If the shopper's shipping country is not one of the countries you specify in this setting, BlueSnap does not appear as an available payment method. (Available countries can be configured in the next setting).



Payment from Specific Countries

If Specific Countries was selected, then this section is applicable. The countries you specify let shoppers, whose shipping countries appear in this list, use BlueSnap to process their credit cards.

Note: To select multiple countries, hold down either the CTRL key (PCs) or Apple/Cmd key (Macs) while you select the countries.



API Username (Sandbox) and
API Password (Sandbox)

  • Enter your API Username and Password for your BlueSnap sandbox account.



API Username (Production) and
API Password (Production)

Enter your API Username and Password for your BlueSnap production account.

Note: Be sure to enter production API credentials to start accepting real transactions.



Debug

  • Select Yes to have communications between Magento and BlueSnap recorded in the debug.log file in the var/log folder of your Magento root. We recommend using this option during the development of your site or if you are experiencing any problems.

  • Select No to opt out of logging communications in the debug.log folder.

Note: Errors are still reported in the var/log/system.log even if Debug is set to No.



IPN IP Whitelist (Sandbox)

By default, this field contains IP addresses from which you'll receive IPN/webhooks keeping you informed of activity in your sandbox account.

Note: In the future, BlueSnap may ask you to add/update IP addresses in this setting.



IPN IP Whitelist (Production)

By default, this field contains IP addresses from which you'll receive IPN/webhooks keeping you informed of activity in your production account.

Note: In the future, BlueSnap may ask you to add/update IP addresses in this setting.



Error Email Recipient

Enter an email address to which messages are sent in the event that a transaction error occurs.

Step 4. Enable SSL

BlueSnap requires a secure connection to process payments.
Please complete these requirements:

  1. Install SSL on your server.

  2. Log into your store as an admin and go to Stores > Configuration > General > Web.

  3. In the Base URLS (Secure) section, configure the following:

    • Set Use secure URLs on Storefront and Use secure URLs in Admin both to Yes.
    • Ensure that the Secure Base URL starts with https://.
  1. Click Save Config.

Step 5. 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.

  1. Log into your BlueSnap account and go to Settings > General Settings.
  2. In the Notifications section, select Receive Instant Payment Notifications.
  3. Update the IPN URL(s) field. The format of the URL should follow this pattern:
    https://www.yourdomain.com/bluesnap/ipn/index
  1. Click Submit.

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.

  1. From your store admin account, go to Sales > Orders.
  2. Click View next to the relevant order.
  3. Click Invoice and scroll down towards the bottom of the page where you'll find a drop down list; choose Capture Online from this list.
  4. Click Submit Invoice.

Magento 2 Setup


Learn how to connect your Magento 2 account to BlueSnap for a unified shopping cart and payment gateway solution.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.