SimplyBluMerchantPortal (Web) UserGuidev1
SimplyBluMerchantPortal (Web) UserGuidev1
Powered by
Table of Contents
Background ........................................................................................................................................... 1
Purpose ................................................................................................................................................. 1
Transactions .………………………........................................................................................... 7
Tokenization ............................................................................................................................. 9
Customers ................................................................................................................................ 9
API Keys................................................................................................................................. 32
Apps........................................................................................................................................ 33
BACKGROUND
SimplyBlu is a cloud-based, Level 1 PCI-certified payment offering of Standard Bank, powered by Mastercard
Payment Gateway Services and hosted by Mastercard, that enables small businesses to quickly and easily take
payments across multiple channels and manage their payments from one simple platform that includes a mobile
application and a variety of intuitive payment features. SimplyBlu is the Standard Bank product (white-labelled
from MasterCard), whereas the core product by MasterCard is known as Simplify Commerce.
PURPOSE
This documentation describes SimplyBlu features and, at a high level, how merchants use the features in their
business. It provides information about the components included in the SimplyBlu platform that enable
merchants to use the platform to take payments and manage their business.
(SimplyBlu)
1
CHAPTER 2: SIMPLYBLU - MERCHANT FUNCTIONALITY
MERCHANT FUNCTIONALITY
SimplyBlu merchant functionality provides secure payment capabilities that enable merchants to conduct
business securely and meet a variety of business needs.
Once a merchant is onboarded by Standard Bank for the SimplyBlu product, the merchant will receive an email
to confirm email address and set a password.
As part of the registration process, the merchant is required to set 2 security questions. The answers to these
questions must be remembered as this will be needed when using the “Forgot Password” function.
2
SIGNING INTO THE SIMPLYBLU MERCHANT PORTAL
Merchants login to SimplyBlu by entering their email address and password and clicking the ‘Login’ button.
3
FORGOT PASSWORD
Merchants who have forgotten their password can reset it by clicking ‘Reset my password’ on the login screen,
which generates a ‘Forgot your password?’ screen, then entering the email address associated with their
account and clicking ‘Submit.’
Merchants click the link in the email to be directed to a password reset page.
Merchants enter the new password twice (to check against error) and click ‘Reset.’
4
If the new passwords match, a confirmation message confirms the password reset, and merchants can login
using the new password.
MERCHANT DASHBOARD
The first thing that merchants see after logging into the merchant portal is the merchant dashboard. The focal
point to the merchant portal, the dashboard provides merchants with a summary of their business. The
dashboard summary view defaults to show the total number of transactions and total volume of payments
received for the last seven days. Merchants can also select a custom date range using the calendar or change
their default through merchant settings. Data is updated in real time. Merchants can select the ‘View’ links in
‘Key Stats’ to be taken directly to the summary data. ‘Net Payments’ is the merchant’s total payments received
less any refunds or declines made.
5
The ‘Recent Analytics’ chart provides a snapshot of the merchant’s transaction activity. The merchant can
change the data displayed in the chart by selecting between ‘Payments’ and ‘Transactions.’
From the dashboard, merchants can choose between the omni channel range of payment and business
management features available in the portal:
➢ Select ‘Transactions’ for payments, authorizations, and summary lists of refunds. All transactions are
tokenized.
➢ Select ‘Customers’ to view, set up and manage customers, view customer history, save customer
cards on file (tokenized), send and track invoices.
➢ Select ‘Stores’ to set up and manage a hosted web store.
➢ Select ‘Developers’ to access SimplyBlu’s APIs and SDKs and other developer documentation,
including plugins.
➢ Select ‘Support’ to access Frequently Asked Questions and up-to-date merchant-facing support
content.
➢ Select the dropdown list to access configurable account settings, including account management and
merchant settings, customer receipt customization, fraud protection, user management for
employees etc., and export data.
TRANSACTIONS
From the navigation bar, merchants select ‘Transactions’ and then ‘Payments.’ Merchants see their payment
history in chronological order and can select filter settings to search the list of transactions.
6
CUSTOMER CARD ON FIL E
If merchants wish to save a new customer with a card on file, an email address for the customer is required. The
sixteen-digit card number is immediately replaced with a unique token (tokenization). A full address is not
required to be saved for a customer. Merchants may choose to save the customer’s address if, for example, a
service is to be completed or goods are to be regularly shipped. Simplify provides merchants with useful extra
information marked by an ‘i.’
Once the form is completed, merchants click ‘Run Payment’ to execute the payment. If the payment was
successful, the message ‘Your payment has been created successfully’ appears as a banner at the top of the
screen. If for some reason the payment was unsuccessful, merchants see ‘Your payment request was declined.
TRANSACTION HISTORY
To view the detail of a certain transaction, merchants select the payment; detailed payment details are displayed
to the right of the transaction list. The status of the transaction indicates if it was successful or declined. The
payment channel will indicate the initiation channel of the transaction. Available channels available are: e-
commerce and hosted payments. Each payment has a unique ID and reference number.
7
AUTHORISATIONS
Merchants can authorize a customer’s card in advance of completing a transaction. Authorization validates that
the transaction is financially secured and approved prior to committing the transaction. Merchants can capture
the authorized amount when they are ready to complete the transaction. SimplyBlu expires the authorization
after seven days. Merchants can capture a partial amount or the full amount and can also reverse the
authorization if needed, which removes the authorization from the customer’s account.
Merchants can use this feature to authorize funds on a new customer card or on a customer card stored on file.
REFUND TRANSACTION
Merchants can review and issue full or partial refunds right from the dashboard.
To issue a refund, merchants find the payment to be refunded by selecting ‘Transactions’ and ‘Payments,’ then
choosing the payment from the list of payments. Payments can be filtered by date, ID and amount to make it
easier for merchants to find the payment to refund. Once located, merchants click on the payment and its details
appear on the screen.
Merchants click the ‘Refund’ link in the upper-right hand corner and fill in the full or partial refund amount and
reason. Once the form is completed, merchants click ‘Make Refund’ to execute the refund. If the refund was
successful, the message ‘Your refund has been processed successfully’ appears as a banner at the top of the
screen.
8
Merchants can also view all the refunds they have issued and search for a particular refund by visiting
‘Transactions’ then ‘Refunds.’
TOKENIZATION
All transactions initiated from the merchant portal, hosted webstore and the Simplify Commerce mobile
application are tokenized. This means that all card numbers entered by the cardholder are immediately replaced
with a unique token for processing. All cards stored on file for recurring payments are stored in a tokenized state
for both cardholder and merchant security. The merchant never sees the full account number and is therefore
not exposed to the risk of security breach of sensitive payment information. The practice also makes it easier
for merchants to maintain PCI compliance. CVC numbers are never stored.
CUSTOMERS
Merchants can also use SimplyBlu to track their transaction history by customer. Once merchants save a
customer in SimplyBlu, the SimplyBlu platform tracks that customer’s transaction history for the registered card
number.
To review customer history, merchants navigate to ‘Customers’ in the navigation bar at the top of the merchant
portal and can see a list of the saved customers. Merchants can select a customer and view all transactions,
invoices paid and owed, and active recurring payment plans for that customer. They can also update items from
this screen.
9
Merchants can easily update and manage individual customers in their customer list. To edit a customer,
merchants select a customer from the list on the left-hand side and can 1) update or delete the customer record,
2) update the card details on file, 3) create a new payment for the customer, 4) view all subscriptions for that
customer and add a recurring payment plan to the customer, 5) view upcoming invoices due and all past invoices
paid, or 6) add a new invoice.
Merchants click ‘New Invoice’ to open the new invoice template. The new invoice remains as a draft until it is
saved or sent. Simplify automatically generates a sequential number and applies it to the invoice. Merchants can
add their own reference number if they wish.
Merchant business information and branding automatically populates in the invoice. Merchants manage their
business settings in the ‘Account Settings’ tab. More information is available in the ‘Merchant Account Settings’
section.
For example, here’s an illustration of an invoice template, customized for a business and ready to be completed:
10
Merchants can choose a customer from their customer list or can manually populate the invoice with customer
details. Merchants select the due date and can apply a late fee depending on their payment terms. The invoice
is compliant with regional rules.
Merchants type the description of the product or service, the quantity of units to be invoiced to the customer
and the price per unit or service. The total is automatically calculated and populated under ‘Total.’
Merchants can set up and manage taxes and add tax as a separate line to the invoice. If merchants select tax to
be added to the invoice, the tax rule will calculate the tax owed and populate the invoice.
The subtotal can be updated with a discount or any applied late fees. Once all required fields are completed,
merchants click ‘Send’ to send the invoice to their customer.
Customers receive the invoice as an email and can pay it securely by card, directly from the hosted page.
11
Once an invoice is sent, merchants can easily edit the invoice and resend, cancel the invoice, mark the invoice
as paid if payment has already been received, or add a late fee to the invoice. If the invoice is edited or cancelled,
merchants can select ‘send notification to customer’ so the customer is notified of any changes.
The first time that merchants access ‘Stores’ they are asked to provide their store name and click ‘Done.’ For
this document, we’ll set up a shoe store called Mad About Shoes.
12
When they click ‘Done’ they are presented with an intuitive checklist of items to do to set up their store, such
as adding products, adding tax or shipping information, setting up merchandise categories or checkout
preferences or further customizing their store. The user interface is easy to use and understand and makes it
easy for merchants to set up their online storefront. This menu of items is always available on the Stores Home
tab, and a merchant’s progress toward opening a store is tracked. Across the top of Stores is the navigation,
which starts with Home and includes Orders, Products, Categories and Settings.
13
ADDING PRODUCTS TO T HE STORE
To add a product, merchants select the Product section, then click the ‘Add Product’ button. Merchants have
the opportunity to enter product information, price, product description (with the ability to format text to add
impact and increase readability) and add multiple images or YouTube videos. Merchants can choose to add a
specific tax to the item, can categorize it, can add a shipping requirement, or can limit purchase amounts of the
item, all from a single page. When merchants are satisfied with a product being listed they click the ‘Save
Product’ button. Clicking the ‘Discard’ button deletes the listing rather than saving it.
14
Merchants also have the option of and tracking inventory including multiple variants for a product. A variant is
a choice available to the customer, such as size or color. To track stock for a product with no variants, toggle the
‘Track Stock’ section on and enter the available inventory for the item. You can also provide a SKU (stock keeping
unit) number and can choose to sell the item even if it is out of stock.
If variants for a product exist, inventory can be tracked at the variant level. Variants are added by toggling the
‘Product Variants’ section on, labelling the variant option and then typing each individual choice. Merchants can
add additional options for a product. When a variant exists, it can be customized with a price differential or a
SKU number. To add inventory at the variant level, toggle on ‘Track Stock’ and enter the inventory for each
variant.
15
Once added, a product appears on the Store’s ‘Product List.’ Merchants can search their product list by a word
in the title or description, which comes in handy once a number of products have been added. They see the first
image for the product, its title, some of its description, its price, and see the number of available variants and
inventory. From here they can also control whether the product is visible in the merchants’ store, delete the
product, share it via social media or view it from the customer’s perspective in the online store.
From the list above, here’s the customer’s view of one of the items:
16
‘BUY-NOW’ BUTTONS AN D SOCIAL SHARING
Simplify also makes it easy for merchants to share and sell individual products. Merchants can click ‘Share’ from
the Product Detail page or hover over the three dots for the product on the product list and select ‘Share’ to
open a pop-up window that provides access to the social sharing feature and the button builder.
When the window opens, merchants have the ability to copy a link to the product or click ‘Tweet’ or ‘Share’ to
publish the product to Twitter or Facebook accounts.
When merchants click ‘Button Builder,’ they have the ability to create a buy button with custom color and
messaging.
Once the button has been created, merchants can copy its JavaScript code displayed in the box and paste it
directly into a site for a PCI-certified hosted payment experience. It’s ideal for merchants selling a single product.
17
IMPORTING PRODUCTS
Merchants can bulk import products to their store by clicking on the ‘Import Products’ button on the product
list page, which can reduce the amount of time to load products to a store. Importing requires the preparation
of an Excel file to be used in the import. A sample file is included for guidance.
EDITING A PRODUCT
By clicking on a product name in the ‘Product List,’ merchants can access and update the Product Details page,
including editing the product photos/videos, its title, price and description. Individual products can be put on
sale, with either a set amount off or a percentage discount. Changes can be saved or discarded. The product can
also be deleted entirely from this page.
When merchants add a product to their store or edit the photo of an existing product, they can upload their
own product photos by dragging and dropping a .png, .jpg or .gif file onto the Crop and Position tool. Merchants
can crop their image to the desired size and can use the resize slider in the top right corner of the page or drag
the image using their mouse to achieve the perfect crop. When they’re finished, they can click ‘Crop & Save’ to
save their progress and return to the product details page.
18
VIEWING AND ADDING A CATEGORY
When merchants add a product to their store, they have the option of adding it to a category of similar products.
To view product categories, merchants select the ‘Categories’ tab from the Stores navigation. Merchants can
add, edit, or assign products to a category from this screen. To add a new category, merchants click “Add
Category,” type in a name, and decide whether to display the category in the online store and on the homepage
of the online store. Once completed, merchants click “Create.”
To edit an existing category, select Categories, choose the category to be edited, then click the ‘Edit Category’
button. Categories can also be deleted from here.
A product can be assigned to an existing category from its Product Detail page. One or more products can also
be assigned to a category when the category has been set up. To assign products, merchants select the products
to be added to the category then click ‘Done.’
19
Selecting Categories from the navigation will always show the categories that have been created for the store.
Merchants can also select one or more categories from the Categories page and perform a bulk action for the
selected item(s). Merchants can choose to enable/show the selected categories in the online store or
disable/hide them. Merchants can also feature or remove categories from the store’s homepage or delete
categories.
Creating the storefront and including information that makes it easy for customers to buy from merchants is
important. SimplyBlu Stores includes a Settings tab on the Stores navigation that contains a comprehensive set
of options that enable merchants to customize their storefronts to suit their needs. Settings include:
▪ General
▪ Design
▪ Pages
▪ Policies
▪ Shipping
▪ Taxes
▪ Domain
▪ Checkout
▪ Notifications
20
GENERAL SETTINGS
General settings collect basic information about merchants and their stores, including their store name, their
logo, the store’s currency, ‘About us’ information that appears on a special page, business and support contact
information and links to the merchants’ social media accounts. Click ‘Save’ when done.
21
DESIGN SETTINGS
From the design settings merchants can choose the overall look of their store from a variety of available themes,
set a homepage image and add messaging.
22
PAGE SETTINGS
Page settings are available when merchants want to add additional pages to the homepage menu bar that
aren’t otherwise generated by Stores. An example is displayed below where a “Customer Support” page was
added to the webstore.
23
POLICIES SETTINGS
Before merchants’ stores can go live, they MUST contain certain eCommerce policies, including Terms and
Conditions, a Privacy Policy, and a Refund Policy. A Shipping Policy should also be provided. Adding these
standard policies to an eCommerce store makes customers more comfortable doing business with merchants
by setting expectations.
IMPORTANT NOTE: The default Terms and Conditions and Privacy Policy and/or Refund and Shipping questions
that should be considered by merchants that have been provided by SimplyBlu were written to meet the needs
of a large number of businesses. It is important for merchants to customize these forms with their business
name, address and other information specific to their business, location or industry.
Setting a particular policy requires toggling on the policy, editing the text that defaults for the policy, and saving
the entry.
The number in the bottom left corner on the main Policies page indicates the number of required policies that
still must be set by merchants for their particular store.
The example below shows the default text for the Terms and Conditions. The Privacy Policy also contains default
text. The Refund and Shipping Policies ask questions that merchants should consider explaining on their site to
promote customer communication and satisfaction and reduce chargebacks.
24
SHIPPING SETTINGS
Merchants can apply one or more shipping rules to their store by selecting the Shipping section and clicking on
‘Add Shipping Rule.’ They can choose to apply a rule to a specific region or country. They can opt for free shipping
or charge a flat rate of their choice. They can apply tax to the shipping charges or exclude them from tax. Once
merchants have set up a rule, clicking the ‘Create’ button saves it.
TAX SETTINGS
Merchants create and manage taxes for products and for jurisdictions that require them from the Taxes section.
They can add one or more individual tax rates and can choose to apply a specific tax rate as a default when
creating a new product. To add a rate, merchants supply a label for the tax, its rate, and click the ‘Add Tax’
button. To delete an existing tax, merchants need only click the grey ‘Delete’ icon to the right of the tax.
25
DOMAIN SETTINGS
Each store is assigned a domain by SimplyBlu Stores. Most merchants make no changes to this setting. The store
URL can be edited by merchants; however, modifying the URL will cause existing links to malfunction. For
example, links to products that have been indexed by search engines will no longer work.
A store can also be linked to an existing domain. Instructions are provided to help merchants configure the DNS
settings of their existing domain in preparation for entering it in the Domain settings and testing connectivity.
Merchants click the ‘Save’ button after completing any changes to the Domain settings.
CHECKOUT SETTINGS
Checkout settings determine when the customer payment is authorized, which can occur at customer checkout
or when the order is fulfilled. If the toggle is turned on, transactions will be authorized at the time of checkout
but will not be completed until the order is fulfilled. Note that orders must be fulfilled by merchants within seven
days to avoid losing the payment as merchants will not be able to capture it again.
26
A purchase creates a pending order for merchants, who change the order to complete when it has been fulfilled
and shipped to the customer. Merchants can choose to fulfill an order immediately upon checkout, which is
ideal for purchases that do not require shipping.
Merchants can add fields on this page that require completion by customers during the checkout process, either
through free-form customer entry or through a customer selecting from options that merchants provide.
A note to the customer that is displayed upon checkout can also be set up from this page.
NOTIFICATION SETTINGS
Merchants have the option to set up a banner that appears at the top of their store by toggling on the Store
Banner option. A message, background color and an accompanying icon are all configurable. The banner can
also be linked to a specific store category, which lends itself to the creation of a Sale category. Clicking the ‘Save’
button stores the banner.
27
ADJUSTING THE STORE STATUS
When a store is ready for business, merchants must make their store visible to their customers by turning on
the toggle in the Settings section that changes the store’s status from Offline to Online. When the toggle is on,
the store is visible to customers and ready for business. The toggle link is also useful to temporarily disable their
store for maintenance or other reasons.
Here is the store we’ve been building thus far, from the customer’s perspective:
28
VIEWING AND MANAGING ORDERS
All orders that merchant stores receive are viewable in a single window. By selecting the ‘Orders’ tab from the
navigation merchants can view all orders or sort to display only pending, complete, cancelled or incomplete
orders. Merchants can also click individual orders to view specific details as well as mark them fulfilled.
MERCHANT SETTINGS
Merchants manage their settings via the merchant portal. Merchant settings flow across the web-based
merchant portal.
From the merchant settings dropdown, merchants have the opportunity to enter information that enables the
SimplyBlu platform to deliver a range of payment and account management features:
▪ Select ‘Account Settings’ for account details, merchant settings, receipts and developer pages where
merchants enter basic information that is used in customer-facing features, password management,
and other areas.
▪ Select ‘Fraud Settings’ to view, set up and manage fraud deterrents.
▪ Select ‘User Management’ to add, modify or delete additional users on the account.
▪ Select ‘API Keys’ to access the public and private API key information for the sandbox (test) and live
environments.
▪ Select ‘Apps’ to provide information for applications built with SimplyBlu. (This section is for
developers.)
▪ Select ‘Web Hooks’ to set up web hooks. (This section is for developers.)
▪ Select ‘Data Export’ to export important business information for analysis or for the merchant’s own
record keeping.
▪ Select ‘Logout’ to sign out of the SimplyBlu account.
29
ACCOUNT SETTINGS
Account Settings house the information that merchants configure for their SimplyBlu account and their business.
It contains four subsections: account details, merchant settings, receipts and developer.
Account Details
In this section merchants can update basic information about their SimplyBlu account, including the name that
is displayed on their account, email address that is used to log in and for all communications coming from
SimplyBlu, and password-related information. Merchants are asked two security questions when they reset their
password. They can choose from a list of common questions, selecting the security questions for which they
easily remember the security answer.
Merchants can also reset their password by entering their current password and new password twice to confirm
accuracy. Passwords must be between 8-20 characters and contain at least one digit and one uppercase &
lowercase letter.
Under ‘Preferences,’ merchants can customize the date range for the analytics that display on the merchant
dashboard. The system default is seven days.
Some merchants (or their developers) set up and use a SimplyBlu sandbox environment to test initial and
ongoing site development. If merchants use a sandbox account, the ‘Delete Sandbox Data’ section allows
merchants to clear all data they have created in the sandbox portal for testing purposes. The feature enables
developers to start fresh after accumulating potentially unwanted test data. Merchants and developers should
keep in mind that this is a permanent deletion; data cannot be retrieved. To delete sandbox data, the developer
clicks ‘Delete Sandbox Data’ and confirms the deletion request.
MERCHANT SETTINGS
Merchants set up branding and other customer-facing information about their business. The information
appears in electronic invoices, customer receipt, and in Stores.
In the ‘Branding’ section, merchants can upload an image to use as their company logo and select an accent
colour. Images must be at least 140 pixels wide and 140 pixels tall. To upload an image, merchants click ‘Select
Logo’ and browse available files to select an image file (acceptable formats include .png, .jpg or .gif).
Merchants use the + and – controls to zoom in or out on the image, which resizes it within the borders. Clicking
the green arrow saves the image; clicking the red x cancels the image upload.
To set up a brand colour, merchants select their preferred colour. The selection will be the accent colour in
electronic invoicing, the ‘buy-now’ buttons, and the hosted payments pages.
The last setting of the ‘Branding’ section is the ‘Hosted Payments - Redirect URL,’ which merchants can use if
they work with developers to set up hosted payments for them. The setting contains the URL that the merchants’
customers are returned to once the payment transaction is complete. The URL must start with http or https. e.g.
https://www.example.com.
For all settings, merchants must click the ‘Save’ button to keep any changes; a confirmation message will appear
at the top of the page to notify merchants that changes have been accepted.
‘Merchant Details’ enables merchants to edit the address information that will be included on e-invoices.
Address fields are localized based on the region (e.g. Postal Code vs. ZIP Code, VAT No., etc.). To confirm any
30
address changes, click the ‘Save Merchant Details’ button, and a confirmation message will appear at the top of
the page.
The ‘Receipts’ section allows merchants to enable/disable email receipts after a payment and customize
customer receipts. There is also an option to set up a receipt for donations/non-profits.
▪ An email receipt sent to the merchants’ email address each time a payment occurs. This is useful for
merchants for awareness of recent payments. The email is sent to the ‘Account Owner’ of the SimplyBlu
account only.
▪ An email receipt sent the customer’s email address after a successful payment.
If merchants enable ‘the customer that made the payment’ checkbox, they can customize the following items in
the email/receipt that is generated for the customer:
Merchants can preview their custom receipt by clicking ‘Send Sample Receipt.’ The sample receipt will be sent
to the email address on file for the user. This email address is stated in the instructions verbiage on the left side
of the screen.
Merchants can save their changes by clicking the ‘Save Receipt Settings’ button at the bottom of the page.
In Production only: If merchants (or their developers) use a sandbox account, they can update the sandbox
currency to simulate payments in the selected currency (of the available currencies in region). The selection will
not affect live payments and is only used for testing. Click ‘Save’ to save changes. After clicking ‘Save,’ developers
can click on ‘Dashboard’ to see the selected currency available in the merchant portal.
FRAUD SETTINGS
SimplyBlu provides basic fraud protection at no cost to the merchant, including:
▪ Decline payments that fail AVS Postal Code verification (region specific)
AVS Postal Code verification means that each time a payment is processed, SimplyBlu y will verify that the billing
Postal Code given at the time of purchase matches the Postal Code associated with the card used for payment.
If it matches, the payment will continue to be processed. If the Postal Code doesn’t match, the payment will be
declined automatically. (Note: AVS is not available in some markets.)
CVC verification means that each time a payment is processed, SimplyBlu will verify the verification code given
at the time of purchase matches the verification code associated with the card used for payment. If it matches,
the payment will continue to be processed. If the CVC doesn’t match, the payment will be declined
automatically.
31
After making changes, merchants must save changes by clicking the ‘Save Changes’ button that appears at the
bottom of the page. To discard any changes, click the ‘Discard Changes’ button.
We offer merchants additional fraud protection, which is described in the Simplify Controls section.
USER MANAGEMENT
The User Management section allows merchants to set up employees with different access levels. There is no
limit to the number of users per merchant account.
Business owners can use the user management settings to set up users with the following roles:
▪ Admin
▪ Developer
▪ Admin: ‘Admin’ role has complete control over the account. The remaining roles limit access, in
descending order.
▪ Developer: The ‘Developer’ role has the same access rights as an ‘Admin’ user except for the ability to
Add/Remove Users and Modify Bank Details. As the name implies, the ‘Developer’ role should be
granted to any developer who is building custom solutions for the business owner with SimplyBlu’s
developer tools.
▪ Read/Write: The ‘Read/Write User’ has the same access rights as the ‘Developer’ role except for the
ability to Access/Modify/Revoke API Keys. The role is commonly used for employees who will be taking
payments from customers (via the virtual terminal, the Simplify Commerce mobile app or other
channels).
▪ Read-only: The role with the least access is the ‘Read-Only User,’ who is granted ‘read-only’ access to
the account and may not accept payments. The role is most commonly used for the customer service
or accounting functions.
To add a new user, click on ‘New User,’ which generates a ‘User Details’ screen. Complete the name, email
address and role for the new user and click the ‘Add User’ button. This automatically generates an email to the
new user, who must respond to the message to complete registration. User information can be updated, and
users can be deleted as the needs of the business dictate.
API KEYS
The API Keys section allows developers to access, manage and create the merchants’ SimplyBlu’s API keys. API
Keys are typically not used by a non-technical business owner. Instead, developers utilize API keys during the
implementation of custom solutions for business owners.
API Keys come in pairs, a public key and a private key. They are used to authenticate merchants to use SimplyBlu
APIs, Hosted Payments and supported plugins. API keys are very important and should only be shared only with
trusted individuals. Developers can create up to five unique live and sandbox keys. In most cases, only one set
of API keys is needed but additional keys can be used for testing or if a SimplyBlu feature requires a unique API
key set (e.g. Hosted Payments).
To generate a new API key set (for developer use with a new SimplyBlu feature or supported plugin), click the
‘Generate New Key’ button. Optionally, developers can enter a key label to identify its use for a particular
32
SimplyBlu feature (e.g. Hosted Payments). Developers can also choose between key types ‘Sandbox’ or ‘Live.’
Sandbox API keys will only work in sandbox payments, and live API keys will only work for live payments.
To enable an API key pair to work with SimplyBlu’s Hosted Payments feature, simply click the ‘enable hosted
payments?’ checkbox, and the most recently created API key pair will be enabled for Hosted Payments with a
green indicator.
The label of an API key pair is used purely for developers to differentiate between API keys if multiple key pairs
are created. The label has no impact on payments. To edit the label of an API key pair, simply enter a label name
in the textbox before creating a new API key pair or click ‘Edit Label’ and enter a label name.
APPS
Developers put information about applications built with SimplyBlu into the ‘Apps’ section.
WEB HOOKS
Developers put web hook information into the ‘Web Hooks’ section.
DATA EXPORT
Merchants can export transaction data to Excel spreadsheets (CSV). The following data lists can be exported:
▪ Payments
▪ Invoices
▪ Customers
▪ Orders
▪ OFX Statements
The data extract lists every transaction made in the date range selected, via virtual terminal, invoices, SimplyBlu
mobile app, social, and Stores.
Merchants can also export their transaction data to OFX Statements, which can then be imported into popular
accounting software platforms such as QuickBooks. SimplyBlu supports OFX 1.0 and OFX 2.1 exports, which can
be used on multiple (old or new) versions of popular accounting software platforms.
To export data, select the data required from the Context dropdown, select the desired date range (last week is
the default), and click the ‘Download File’ button to begin the download.
Support information and Frequently Asked Questions (FAQs) are available and accessed from the merchant
portal by selecting ‘Support.’
The available information is white labelled and localized to reflect the merchants’ countries. Additional
questions/responses supplied by the Partner can be included.
From the support page, merchants see a list of FAQ topics followed by the most frequently visited questions
for those topics. Selecting ‘View All’ displays all FAQs under a given topic.
The ‘Contact Us’ section displays a list of available resources for customer support.
33
CHAPTER 3: SIMPLYBLU – DEVELOPER
This section provides an overview of the Simplify functionality available for Developers.
DEVELOPER DOCUMENTATION
Simplify Commerce was designed to make integration easy for merchants if they have custom requirements.
Information is fully available online. From Simplify.com, merchants can click ‘Documentation,’ or from the
merchant portal, merchants can click ‘Developers.’ Merchants (or developers on their behalf) can access APIs
and SDKs in nine programming languages (including iOS and Android). Each API includes detailed information
about methods and parameters as well as sample code that developers can use. Simplify offers a variety of tools
and tutorials for developers. To help developers test their code, we provide special card numbers that enable
the testing of specific scenarios and API error information to help developers troubleshoot their code.
Supported Languages:
▪ iOs
▪ Apple Pay (in-app)
▪ Android Pay (in-app)
▪ Python
▪ Ruby
▪ PHP
▪ Java
▪ Perl
▪ .NET
▪ Node.JS
▪ Authorization
▪ CardToken
▪ Coupon
▪ Customer
▪ Invoice
▪ Payment
▪ Plan
▪ Refund
▪ Subscription
▪ Tax
▪ Transaction Review
▪ Webhook
34
PLUGINS AND PARTNERSHIPS
▪ WooCommerce
▪ Shopify
▪ PrestaShop
▪ Magento
▪ X-Cart
▪ OpenCart
▪ Drupal
▪ osCommerce
▪ WP eCommerce
▪ Joomla – Virtuemart
▪ nopCommerce
HOSTED PAYMENTS
SimplyBlu makes it easy for developers to offer their merchants a simple, hosted payment solution to
complement their existing website.
With hosted payments, when a consumer is ready to buy, a simple checkout window pops up. Customer can
check out by entering their payment and shipping details.
Accessible from the Tools section of SimplyBlu’s developer documentation, developers have two options to use
a hosted payment window on a webpage – using it as a modal or embedding it directly into the page.
Each option is explained in the online section devoted to hosted payments, with easy-to-follow instructions for
setting up and testing the capability. There is also information on browser support and troubleshooting.
SIMPLIFY LINK
SimplyBlu APIs support the use of the OAuth 2.0 through endpoints for applications. Developers use Simplify
Link to authorize access to SimplyBlu APIs for web applications, desktop applications, mobile phones, and other
devices without having to store sensitive credentials, making it easy for merchants’ customers to make
payments.
35