Support Guides

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.

Supported features

  3-D Secure
  Apple Pay
  Built-in Fraud Prevention and Risk Management
  Chargeback Management
  Credit and Debit Card Processing
  Multiple Currencies
  Multiple Languages
  Payment Analytics and Reporting
  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.

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

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

  1. Download the BlueSnap extension file to your machine.

  2. In the app/cide directory of your Magento installation, create a BlueSnap directory and create a Payment directory in the BlueSnap directory .

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

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

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

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

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

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

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

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

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

  • Select No to disable this option.

IPN Configuration

Copy the URL from this section and use it for the IPN Setup section below.

Enable 3D secure

  • If you want to offer 3‑D Secure, contact BlueSnap Merchant Support and ask for 3‑D Secure to be enabled for your account. After that is done, you can select Yes here to activate 3‑D Secure. For more information on 3‑D Secure, refer to our 3‑D Secure Guide. (Note: This link opens in a new tab.)

  • Select No if you do not want to use 3‑D Secure.

Enable Apple Pay

  • If you want to offer Apple Pay as a payment method for your shoppers, contact BlueSnap Merchant Support and ask for Apple Pay to be enabled for your account. After that is done, you can select Yes here to allow shoppers to pay with Apple Pay.

  • Select No if you do not want to present this option.

Enable Dynamic Currency Conversion (DCC)

Shoppers can always choose the displayed currency. This setting determines the currency for the actual charge.

  • If you select Yes, if a shopper selects a preferred currency that is different from the store base currency, their charge will be converted to their preferred currency.

  • If you select No, the displayed currency changes but the actual charge will be in the store base currency.

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 processing live transactions.

Payment Action

  • Select Authorize Only to only run an authorization on the card to ensure there is enough available credit; however, payment is not processed until the capture step. We recommend that you use this option if you plan to 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.

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.

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

  • Select All Allowed Countries to allow BlueSnap to be listed as a payment option for any country configured in Magento.

  • Select Specific Countries to restrict the BlueSnap payment method 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 is not an available payment method. (Available countries are configured in the next setting.)

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.

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

BlueSnap Seller ID

Enter your merchant ID number from your BlueSnap merchant account.

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 processing live transactions.

Debug

  • Select Yes to have communications between Magento and BlueSnap recorded in the var/log/payment.log file 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 payment.log folder.

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

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.

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

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.

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

  1. Click Save Config.

  2. 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:

  1. Install SSL on your server.

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

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

  4. Click Save Config.

Step 5. Currency configuration

  1. Log in to your Magento store as an admin and go to Stores > Configuration > General > Currency Setup.

  2. Set the following:

    • Base Currency
    • Default Display Currency
    • Allowed Currencies — Only choose currencies supported by BlueSnap.

  3. Click Save Config.

  4. If you have Magento caching enabled, go to System > Cache Management, and click Flush Magento Cache.

  5. Go to Stores > Currency Rates.

  6. In the Import Service box, select BlueSnap. This lets you import the BlueSnap currency rates.

  7. Click Import.
    The table shows the currency conversion rates.

  8. Click Save Currency Rates.

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

  1. Log in to 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

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

  1. In your Magento store admin account, go to Sales > Orders.

  2. Click View next to the relevant order.

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

  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.