BluePay Magento 2 – User Guide

This documentation contains a step -by-step guide on installing the plugin and also how to

utilize all of the plugin’s features. This plugin is designed to work wit h the Magento 2

platform and a BluePay gateway account.

CONTENTS

1 Installing the Magento 2 Plugin ............................................................................................................................... 1

1.1 Installation steps .................................................................................................................................................. 1

1.2 Setting up the plugin ........................................................................................................................................... 2

2 Processing through the extension........................................................................................................................... 6

2.1 Frontend orders.................................................................................................................................................... 6

2.2 Backend Orders..................................................................................................................................................... 7

2.3 Backend invoices .................................................................................................................................................. 8

2.4 Backend Refunding.............................................................................................................................................. 9

3 Stored Payment Accounts/Tokenization ........................................................................................................... 10

3.1 Checkout Page .....................................................................................................................................................10

3.2 Customer Portal ..................................................................................................................................................11

1 INSTALLING THE MAGENTO 2 PLUGIN

1.1 INSTALLATION STEPS

Installing the plugin is straightforward; you can get the extension via github at https://github.com/jslingerland/BluePay_Payment_M2. Follow the instructions to complete the installation on your web server.

1.2 SETTING UP THE PLUGIN

For this portion, you wi ll need to gather two pieces of information that are specific to your BluePay gateway account: your Account ID and your Secret Key. To get these: Log into h tt ps ://s e c u re .blu e pay.c o m using your Account Name, Username, and Password.

After you’ve logged in, navigate to Admin -> Accounts -> List.

Click on the link that sh ows your account name, sh own below.

Finally, at the Account Admin screen, you will find your Account ID and Secret Key, shown below. Keep this tab open as you will need it momentarily.

Going back to your oth er open tab for Magento , navigate to Stores -> Configuration ->

Sales -> Payment Methods. Scroll down until you see “BluePay (Credit Card/eCheck).

To complete your installation of the BluePay Magento extension , you must enter in your

Account ID and Secret Key on this Settings page, as well as the other values that are specific to Magento transaction processing. Go ahead and copy your Account ID and Secret

Key from your other tab and paste these into the fields on the Settings page.

The other fields are:

Enabled – If set to “Yes” , will show up in your store ’s frontend to allo w customers to use

this extension to process payments.

Title – The title of the payment method that ’s displayed to the customer on the checkout

page.

Payment Type – The type of the transaction that gets processed on the frontend and backend. If you want yo ur customers to be able to choose either a credit card or an

electronic check as a payment method, choose “Credit Card & eCheck Enabled ”. Otherwise,

choose either Credit Card or eCheck only.

Transaction Mode – This determines if transactions processed th rough the plugin are

LIVE or TEST. It is recommended to leave this as TEST and to run a few test transactions

before switching over to LIVE mode.

Transaction Type – Fo r credit card transactions, you can choose to either process as an

authorization only, or an au thorization and a sale in one. For merchants that don ’t ship

right away, we recommend choosing authorization only. If this is chosen, an invoice will need to be captured o nce the order is set to be shipped.

Credit Card types – The types of credit cards that y ou want to accept from your customers.

Credit Card Verifica tion – If enabled, will force your customers to enter in their 3 or 4 digit CVV2 value when purchasing from your store.

Allow Customers To Store Payme nt Methods – This is an option that you can set if you’d

like to allow your customers to securely store their payment information after a

transaction is processed through the plugin. If enabled, a customer has the option to save

their credit card or eCheck account on the checkout page. When they return to shopping

at a later time, any stored payment accounts will be populated for them via a dropdo wn

list.

Enable Iframe Support – If selected, a hosted payment form is used within an iframe to

collect payment information. This means that all credit ca rd/ACH information never touches your servers since your customers are entering in that data on a secure, BluePay

hosted payment form.

New Orde r Status – The order status that gets set after an order is created. Possible

values are:

Processing

Pending

Complete

Payment Review

On Hold

Debug – If enabled, will log debu gging information to your var/log/debug.log file.

New Orde r Status – The type of currency that you accept through your store.

Payment from Applicable Countries – The list of countries that you accept payment

from.

Payment from Specific Countries – If “Paym ent from Applicable Countries ” is not set to “All Allowed Countries ”, here you can specific the exact countries that you accept payment

from.

2 PROCESSING THROUGH THE EXTENSION

This section will cover the following t opics: frontend orders, backend orders, backend invoices, and backend refunding.

2.1 FRONTEND ORDERS

Once the extension has been configured, you ’re ready to start having your customers

process payments through the BluePay gateway right on your store. When a cu stomer

selects their product(s) and get to the checkout page, a new payment method should be added for them titled “BluePay Credit Card/eCheck ” (or however you have it titled).

Once the customer enters in his or her payment information and clicks on “Place Order”, they will get a real -time response as the transaction is processed by BluePay. If declined

or an error occurs, a message will appear at th e top of the screen indicat ing so. Otherwise,

the transaction is approved and an order is created. The customer is redirected to an

order confirmation page, and the order is completed.

*Note: if the transaction type that you have chosen on the Configuration page was

set to “Authorize Only ”, you wi ll need to cre ate an invoice at some point to actually capture the funds.

2.2 BACKEND ORDERS

If you want to create an order in the backend o n behalf of one of your customers, you may

do so by navigating to S ales -> Orders -> Create New Order. After choosing the customer

and the product(s), you will need to enter the payment information for the customer before submitting the transaction information to be processed.

If approved, the order i s then created.

2.3 BACKEND INVOICES

As mentioned before , if you have it set to Auth orize Only, an invoice will need to be

generated to capture the payment that has been authorized so that you get paid. To do

this, go to Sales -> Orders. Here, click on the order that needs to be invoiced. In the upper

right, click on “Invoice” in the menu bar. Before creating the invoice, make sure that

“Capture Online ” is chosen, then click on “Submit Invoice ”. This will send a request to the

BluePay gateway to capture the initial authorization of the order. If successful, the invoice

is created and the order is updated.

2.4 BACKEND REFUNDING

If you need to refund a customer at any point, the extension allows th is right through your

Magento store. Navigate to Sales -> Orders. Choose the order to refund, click on the actual

invoice of that order, and finally click on “Credit Memo ”. Here, you can refund the item(s),

the shipping, etc. The extension allows you to do partial re funding as we ll, so you do not

need to refund every item of the order. Click on the “Refund” button to finalize the refund.

3 STORED PAYMENT ACCOUNTS/TOKENIZATION

3.1 CHECKOUT PAGE

If you choose to allow your customers to store their payment information, a couple of

additional fields are added to the checkout page. First is a dropdown box with all stored

payment accounts that the customer can choose from. Customers are a ble to store either

credit cards or eCheck payments (or both if choose to process both).

Once a stored payment account is selected, the tokenized payment info rmation is

automatically populated so that they do not need to enter this information by hand. If the transaction is a credit card payment and “Credit Card Verification ” is enabled, the

customer will need to h and -key their CVV2 value since this is not stored by BluePay, per PCI compliance.

3.2 CUSTOMER PORTAL

Customers may also view/update their stored payment information themselves. Once they get

signed in, they can navigate to the “My Sto red Payment Accounts ” link on the left -hand side

of their page. Here, they can ad d/modify/delete stored payment accounts themselves.

If adding a new payment account or modifying an existing one, a request is sent to the

BluePay gateway upon clicking the “Submit” button. At this point, the payment

information is tokenized and a ma sked payment string w/ accompanied token is stored

within your Magento store. All of the sensitive data is stored on BluePay ’s end to greatly

help with PCI compliance.