@
SAGICOR BANK PAYMENT GATEWAY
USER MANUAL
CONTENTS GETTING STARTED MAIN FEATURES
03
Menu Bar Home Page Search Order Reports Admin Transaction Filtering
12 12 13 14 15 17 20
11
TECHNICAL SUPPORT 34 GLOSSARY 36
SPGS - Merchant Administration User Guide
01
SAGICOR BANK PAYMENT GATEWAY
Thank you for choosing Sagicor Bank Payment Gateway Services (SPGS), the Easy, Simple, Personal way of accepting credit card payments online locally and internationally. WHAT YOU’LL NEED To use Sagicor Bank Payment Gateway (SBPG) Services, you need: • Access to the Internet. • Your Merchant ID. • Your Operator ID. • Your Password. • JavaScript and cookies enabled in your browser. • An up-to-date web browser such as Firefox, Internet Explorer, Microsoft Edge or Chrome. 02
SPGS - Merchant Administration User Guide
GETTING STARTED
So, you have signed up for Sagicor Bank’s Payment Gateway Services and integrated the service, what next? Complete the following steps to get started.
04
SPGS - Merchant Administration User Guide
STEP 1: LOG IN AS AN ADMINISTRATOR When you log in to Sagicor Bank Payment Gateway Services for the first time, you must type “Administrator” in “Operator ID” field. Once you are logged in, you must create an Operator ID, log out and then sign-in with those credentials. To log in to Sagicor Bank Payment Gateway Services, visit: https:// sagicorbank.gateway. mastercard.com/ma 1. 2. 3. 4.
Enter your Merchant ID. Enter your Operator ID. Enter your Password. Click LOG IN.
Remember to change the default password
Note: (If you have forgotten your password, click the Forgot Password link.)
SPGS - Merchant Administration User Guide
05
STEP 2: CHANGE PASSWORD Once you access Sagicor Bank Payment Gateway Services for the first time you will be prompted to change the default password provided by Sagicor Bank. To change your default password provided by Sagicor Bank, follow these steps: 1. Enter old password. 2. Enter new password. 3. Confirm new password.
06
SPGS - Merchant Administration User Guide
STEP 3: CREATE OPERATORS From the main menu, select Admin. Click “Operators” from the drop down list. 1. Select “Create a new Merchant Administration Operator”. 2. Enter the details as required. 3. Click Submit once you have entered all the details.
SPGS - Merchant Administration User Guide
07
EDIT OPERATOR
1. From the main menu, select Admin then click “Operators” from the drop down bar. 2. From the list displayed, click Edit for the Operator you want. 3. Make the changes you require. 4. Click Submit.
08
SPGS - Merchant Administration User Guide
CHANGE OPERATOR PASSWORD 1. From the main menu, select Admin then the click Operators from the drop-down menu. 2. From the list displayed, click Change Password, enter new password. 3. click Submit. DELETE OPERATOR 1. From the main menu, select Admin then the click Operators from the drop-down menu. 2. From the list displayed, click Delete.
SPGS - Merchant Administration User Guide
09
STEP 4: LOG OUT AND LOG IN AS AN OPERATOR After you have created Operator(s), you will be required to log out and then log in as an Operator. Click the log out link in the top right corner of the screen. Note: You will be logged out automatically after 15 minutes of inactivity. To 1. 2. 3. 4.
10
log in as an Operator: Enter your Merchant ID. Enter your Operator ID. Enter your Password. Click Log In.
SPGS - Merchant Administration User Guide
MAIN FEATURES
MENU BAR Once you log in, the landing page will show a green menu bar which will give you access to the home page, search, order, reports, admin and transaction filtering tabs.
THE HOME PAGE The home page of the Merchant Administration portal displays the following: • Your DashboardThe dashboard provides a summary view of your transaction activity to enable you to see key performance data at a glance. • Shortcuts- This menu provides quick access to common tasks that you might need to perform on a day-today basis.
View Transactions Processed Today: Searches for transactions with today’s date and displays a list of transactions that match the criteria. 12
SPGS - Merchant Administration User Guide
SEARCH The search tab redirects you to the Order and Transaction Search page, where you can view orders and transaction over a period. VIEW TRANSACTIONS From the main menu, select Search then Orders and Transactions. You can also search by amount, card number, customer name, etc. A more advanced search can be done, by specifying options such as the payment method in the section below the search bar.
Information displayed in the transaction table: Order Date, Order ID, Order Reference (if one is set by the merchant), Order Amount, Order Status.
SPGS - Merchant Administration User Guide
13
The transaction details page allows you to carry out several actions. This is outlined below: REFUNDS From the Actions dropdown button, select Refund from the list. A pop up will appear, where you will be required to enter the refund amount. The refund amount can be the full amount or a partial value of the transaction. Click the refund button, the transaction Status will be changed to Cancelled.
ORDER Items under Order such as Create Order and Verify Only, is not available in this configuration.
14
SPGS - Merchant Administration User Guide
REPORTS This tab allows for the viewing of the transaction summary report. Gateway Reports display the details of all merchant’s transactions that have been processed. It allows you to search for and list the transaction details by date, time interval (daily, weekly, monthly and yearly), card scheme and currency. To view a Gateway report summary: 1. From the Main menu, select Reports > Gateway Reports. The Gateway Reports search page will be displayed. 2. Enter your search parameters. 3. Click Submit to display the Gateway Report Summary page.
SPGS - Merchant Administration User Guide
15
GATEWAY REPORTS SEARCH PAGE Use the fields on the Gateway Reports search page to enter the search parameters for your order search. VIEWING A GATEWAY REPORT SUMMARY A Gateway Report is grouped into sections by transaction currency and the payment method. Each row of the list provides aggregated details for transactions processed by a specific acquirer, using a specific currency, and occurring in a specific period. The size of the period is determined by the Time Interval selected on the Gateway Report Search page. Each row of the list specifies the details described in the table found on page 31.
16
SPGS - Merchant Administration User Guide
EXPORT TRANSACTION REPORTS From the Order and Transaction Search page, click the export to csv button located above the transaction listing table. You will be carried to a CSV Export page; some fields will be preselected for quick report exporting. You can select additional fields that you may require information for. After you are satisfied with your selection click the Export button. The CSV file will automatically be downloaded to your device. Note: To download orders and transactions in CSV format, you must be enabled for “Download Order Search Results” and “Download Transaction and Payment Authentication Search Results” respectively.
ADMIN The admin tab provides options to change your password add or modify operators, manage email notification on payments and refund.
SPGS - Merchant Administration User Guide
17
TO EDIT AN OPERATOR: From the Main menu, select Admin > Operators. The Operator List page is displayed. 1. The Edit an Operator section lists all existing Operators. You can do any of the following: − To edit an Operator, click Edit. The Operator Details page is displayed.
TO DELETE AN OPERATOR: 1. Click Delete. A message prompts you to confirm deletion. Click OK or Cancel as appropriate. To change an Operators password: 2. Click the Change Password link. The Change Password page appears. Note: The Change Password link does not display for the logged in user. Use Admin > Change Password to change the password of the currently logged in Operator.
18
SPGS - Merchant Administration User Guide
UNLOCKING AN OPERATOR ACCOUNT: If a Merchant Administration Operator with administration privileges enables “Lock Operator Account” privilege for the Operator profile, then the Operator gets locked out of Merchant Administration. Note: To reinstate a locked-out Merchant Administration Operator, you must have the May Perform Operator Administration user privilege. To reactivate a locked-out Merchant Administration Operator, log in as an activated Operator with the appropriate privileges: 1. From the Main menu, select Admin > Operators. The Admin – Operator List page is displayed. 2. Identify the Operator to edit and select Edit. The Operator Details display, with the existing values and settings in the fields. 3. Deselect the Lock Operator Account check box. 4. Click Submit to commit the changes. The Operators account has now been unlocked.
SPGS - Merchant Administration User Guide
19
TRANSACTION FILTERING Transaction Filtering allows you to configure rules to control which transactions the gateway should process. You can configure rules based on the following: TRUSTED CARDS Transactions with trusted card numbers are always accepted automatically. However, the transaction filtering rules configured at the Merchant Services Organization(MSO)/ Bank level will override the rules set for trusted cards. Trusted cards list is a set of credit card numbers owned by those card holders whom the merchant considers trustworthy to transact with. Typically, a card holder with a good record of transaction history has a high potential of being added to the trusted card list. Configuring trusted card rules ensures that transactions from trusted cards are always accepted.
20
SPGS - Merchant Administration User Guide
ADDING A TRUSTED CARD NUMBER 1. From the Main menu, select Transaction Filtering > Trusted Cards. The Trusted Cards page is displayed. 2. In Add New Card Number field, enter the Card Number, Card Holders Name, Reason. 3. Click Add. REVIEWING CURRENT TRUSTED CARD NUMBERS From the Main menu, select Risk Management > Trusted Cards. The Trusted Cards page is displayed. The Current Trusted Card Numbers section displays a list of all currently added trusted card numbers and their corresponding details. TO FILTER THE LIST BASED ON A CARD NUMBER: 1. Enter the card number in the Filter by Card Number text box. Click Clear if you wish to clear the filter string. 2. Click Go. Only card numbers that match the filter criteria are displayed in the Current Trusted Card Numbers list. The card numbers are sorted in ascending order.
SPGS - Merchant Administration User Guide
21
TO EDIT A CARD NUMBER: 1. Click Edit option next to the card number record. 2. Make changes to the required fields. When you modify the card number, ensure that you enter the complete card number for validation purposes. Editing Card Holder name and Reason do not require you to enter the card number. 3. Click Update to process the changes. 4. Click Cancel if you wish to cancel the changes. DELETING TRUSTED CARD NUMBERS 1. From the Main menu, select Transaction Filtering > Trusted Cards. The Trusted Cards page is displayed. The Current Trusted Card Numbers section displays a list of all currently added trusted card numbers and their corresponding details. If the list of trusted cards exceeds 20 entries, pagination triggers which allows you to navigate between multiple pages. 2. Use the Filter By Card Number option to find card numbers you may wish to delete. 3. Select the card number you wish to delete by selecting the check boxes under the Select column. You may use Select All /None to select/clear all card numbers. 4. Click Remove Trusted Card Numbers to delete the selected card numbers. 22
SPGS - Merchant Administration User Guide
SUSPECTS CARDS Transactions with suspect card numbers are always rejected automatically. Suspect cards list is a set of credit card numbers owned by those card holders whom the merchant considers untrustworthy to transact with. Typically, a card holder with fraudulent transaction history has a high potential of being added to the suspect card list. Configuring suspect card rules enable you to block transactions from suspected cards. IP ADDRESS RANGE You can configure a single IP Address or an IP Address range. For example, if you wish to configure a rule for IP Address 111.112.113.0, simply type 111.112.113.0 as the IP Address Range Start entry. If the defined IP Address ranges overlap to belong to both the categories, the action Reject will override the action Review. For example, if there were two IP address ranges defined with values 150.211.4.0-192.208.1.4 with action set to Reject and 192.208.0.0-192.208.9.7 with action set to Review, note that there is an overlap from 192.208.0.0 to 192.208.1.4, this SPGS - Merchant Administration User Guide
23
means that if a browser payment was originated from an IP address that falls within the aforementioned “rejected range�( 192.208.0.0 to 192.208.1.4) the transaction would fail and only transactions 192.208.1.5-192.208.9.7 would be under Review.
ADDING AN IP ADDRESS RANGE RULE 1. From the Main menu, select Transaction Filtering > IP Address Range Rules. The IP Address Range Rules page is displayed. Note: You cannot override the IP Address Range Rules configured by then Bank. 24
SPGS - Merchant Administration User Guide
2. In the Add IP Address Range Rule section, enter the following information to add a new range for blocking. You can choose to block a single IP address or an IP address range. For example, if you wish to block IP Address 192.0.2.255, simply type 192.0.2.255 as the IP Address Range Start entry and choose the required action. To block an IP address range, say 192.0.2.222 to 192.0.2.255, type 192.0.2.222 and 192.0.2.255 as the start and end IP address ranges respectively. 3. Click Add. The IP Address Range Rules page redisplays with the updated current IP address range rules list. Note: • The IP address must be specified in IPv4 format between the range 0.0.0.0 and 255.255.255.255. • If the defined IP ranges overlap to belong to both the categories (Review and Reject), then the action Reject overrides the action Review. REVIEWING CURRENT IP ADDRESS RANGE RULES From the Main menu, select Risk Management > IP Address Range Rules. The IP Address Range Rules page is displayed. The Current IP Address Range Rules section displays a list of all currently configured IP Address range SPGS - Merchant Administration User Guide
25
rules in ascending order and their corresponding action status. To filter the list based on an IP Address or to find an IP address in a range or overlapping ranges: 1. Enter the IP Address in the Filter Ranges by IP Address text box. Click Clear if you wish to clear the filter string. Clearing the filter repopulates the entire list of IP address ranges and turns off the filter mode. Filter Mode: Off indicates that the filter option is not enabled on the IP Address Ranges list. 2. You can also use the filter option to check if an IP range is blocked currently. 3. Click Go. Only IP ranges that matches the filter criteria are displayed in the Current IP Address Range Rules list. The IP ranges are sorted in ascending order. Filter Mode: On indicates that the filter option is enabled on the IP Address Ranges list. DELETING AN IP ADDRESS RANGE RULE 1. From the Main menu, select Risk Management > IP Address Range Rules. The IP Address Range Rules page is displayed. The Current IP Address Range Rules section displays a list of all currently configured IP 26
SPGS - Merchant Administration User Guide
2. 3.
4.
5.
Address Range rules and their corresponding action status. If the list of current IP Address Ranges exceeds 20 entries, pagination triggers which allows you to navigate between multiple pages. Use the Filter Ranges by IP Address option to find an IP address in a range or overlapping ranges. Select the IP Address range you wish to delete. You may use Select All/None options to select/clear all the records. Click Delete. A warning message displays, which alerts you about deleting IP ranges that may occur in multiple IP ranges if overlapping IP ranges have been defined. Click Yes if you wish to proceed with the deletion of the selected IP ranges. Click No to cancel the deletion.
IP COUNTRY IP addresses can help in identifying the location of the card holder. Configuring IP Country Rules enable you to block transactions originating from a pre-defined list of countries. You can also choose to configure additional rules to block countries identified as using IPs from unknown countries or IPs of anonymous proxies that mask the true origin of the request. SPGS - Merchant Administration User Guide
27
At the merchant level, you can configure countries to either of the following three categories: • No Action (processed normally) • Review (processed or blocked manually) • Reject (blocked automatically) However, the Bank can configure countries to only No Action and Reject categories. Note: • A country can only be configured to one category at any given time. • A browser payment will be rejected if originating from an IP address of a country which is listed in the Reject list. PREREQUISITE To configure IP Country Rules, you must have May Configure Risk Rules operator privilege.
28
SPGS - Merchant Administration User Guide
HOW TO ADD AN IP COUNTRY RULE 1. From the Main menu, select Risk Management > IP Country Rules. The IP Country Rules page displays with three list boxes: • No Action- lists countries you wish to accept transactions from. • Review- lists countries you wish to mark for review before proceeding with the order. Marking countries for review provides merchants with the flexibility
SPGS - Merchant Administration User Guide
29
to take a decision on whether to process or reject a transaction from the specified country. • Reject- lists countries you wish to reject all transactions from. Note: You cannot override the IP Country Rules configured by your MSO. Under the Add an IP Country Rule section, choose the action you want to perform on unknown countries and anonymous proxies. DELETING AN IP COUNTRY RULE 1. From the Reject list box, select the country for which you want to delete the IP Country Rule. Note: Press CTRL to select multiple items. 2. Click No Action to move the country to the No Action list box. 3. Click Save to process the IP Country Rule. All transactions from countries listed in the No Action list box will be processed normally. Note: You cannot override the IP Country Rules configured by the bank.
30
SPGS - Merchant Administration User Guide
CARD BIN RANGE RULE You can configure a single BIN or a BIN range. For example, if you wish to configure a rule for BIN 123456, simply type 123456 as the BIN Range Start entry. If the defined BIN ranges overlap to belong to both the categories, the action Reject will override the action Review. The card Bank Identification Number (BIN) can help in identifying the location of the card issuer. Configuring Card BIN Rules enable you to block or review transactions from a specific BIN or all BINs within a range. At the merchant level, you can configure Card BINs to only two categories: • Review (processed or blocked manually) • Reject (blocked automatically)
SPGS - Merchant Administration User Guide
31
ADDING A CARD BIN RULE 1. From the Main menu, select Transaction Filtering > Card BIN Rules. The Card BIN Rules page is displayed. Note: You cannot override the Card BIN Rules configured by the Bank. 2. In the Add BIN Rule section, enter the following information to add a new range for blocking. You can choose to block a single BIN or a BIN range. For example, if you wish to block BIN 123456, simply type 123456 as the BIN Range Start entry. To block a BIN range, say 111111 to 222222, type 111111 and 222222 as the start and end BIN ranges respectively. 3. Click Add. The Card BIN Rules page re-displays with the updated current BIN rules list. Note: The BIN must be six numeric characters in length and cannot start with zero. Reviewing Current Card BIN Rules From the main menu, select Transaction Filtering > Card BIN Rules. The Card BIN Rules page is displayed. The Current BIN Rules section displays a list of all currently configured Card BIN rules in ascending order and their corresponding action status. 32
SPGS - Merchant Administration User Guide
If the list of current Card BIN ranges exceeds 20 entries, pagination triggers which allows you to navigate between multiple pages. DELETING A CARD BIN RULE 1. From the Main menu, select Transaction Filtering > Card BIN Rules. The Card BIN Rules page is displayed. The Current BIN Rules section displays a list of all currently blocked BIN ranges and their corresponding action status. If the list of current Card BIN ranges exceeds 20 entries, pagination triggers which allows you to navigate between multiple pages. 2. Select the BIN range you wish to delete. You may use Select All/None options to select/clear all the records. 3. Click Delete. A warning message displays, which alerts you about deleting BIN ranges that may occur in multiple BIN ranges if overlapping BIN ranges have been defined. 4. Click Yes if you wish to proceed with the deletion of the selected BIN ranges. Click No to cancel the deletion.
SPGS - Merchant Administration User Guide
33
TECHNICAL SUPPORT
TECHNICAL SUPPORT
888 SAGICOR (724-4267)
sbj_paymentgateway@sagicor.com sagicorjamaica.com
SPGS - Merchant Administration User Guide
35
GLOSSARY
GLOSSARY
GENERAL ADMINISTRATION PORTAL TERMS Administrator Operator
Password
The Administrator is responsible for the creation and maintenance of Operators. An Operator can do the following view orders and transactions; view Gateway Reports; export Transaction and Order Reports; configure Merchant emails; change own password; create an Operator; configure Operator user privileges; change password for another operator; delete operators; captures ; refunds; search for tokens and transaction filtering. Must be at least eight characters long, contain at least one alphabetical character and numeric character and is case-sensitive.
LOGIN FIELD DESCRIPTIONS FOR STEP 1 Merchant ID
The merchant’s unique alphanumeric identifier provided with each merchant account/profile. This is provided by the Bank.
Operator ID
The unique username for that operator.
Password
Must be at least eight characters long, contain at least one alphabetical character and numeric character and is case-sensitive.
Operator Name
The name of the Operator.
Description
Extra description of the user (for example, job title, department or level of privileges allocated).
Email Address
The Operator’s email address. Temporary password is sent to this email address when the Operator uses the Forgot Password link on the Login screen to request a password reset.
SPGS - Merchant Administration User Guide
37
Perform Verification Only
Allows the operator to perform address verification on payers. (This is currently not supported by the Gateway.5)
Perform Captures
Allows the operator to perform captures and allows user to mark orders as complete.
Perform Voids
Allows the operator to void transactions. A void is the cancellation of a previous transaction.
Allows the operator to void transactions. A void is the cancellation of a previous transaction. . Modify the merchant configuration.
Allows the operator to give refunds. A refund is the transfer of funds from a merchant to a card holder.
Perform operator administration
Allows the operator to create, edit and delete other Operators details.
View Gateway Reports
Operator can view Gateway Reports.
Download Order Search Results
Allows the Operator to download order search results in CSV format.
Download Transaction and Payment Authentication Search Results .
Allows the Operator to download transaction and payment authentication search results in CSV format.
38
Allows the operator to edit the merchants configuration details.
SPGS - Merchant Administration User Guide
Allow Software Download
Feature not supported in this configuration of the gateway.
Allow Merchant Administration Documentation Download
Feature not supported in this configuration of the gateway.
May Perform Risk Assessment Review
Allows the operator to decide on whether to accept or reject an order based on the risk assessment results.
May Configure Integration Settings
Allows the operator to configure integration settings for a merchant, which allow the merchant application to directly connect to the payment gateway.
May Configure Reporting API Integration Settings
Allows the Operator to generate passwords used to integrate with the reporting API and download Transaction reports.
May Bypass Risk Management
Allows the operator to process orders without performing risk assessment on orders. If both internal risk and the external risk provider are enabled, this privilege bypasses both.
May Configure Notifications
Allows the operator to configure merchant and customer notifications for payment events such as successful payments, successful refunds, etc.
May Maintain Tokens
Allows the operator to delete tokens associated with the merchant’s token repository.
SPGS - Merchant Administration User Guide
39
LOGIN FIELD DESCRIPTIONS FOR STEP 7 Merchant ID
The merchant’s unique alphanumeric identifier provided with each merchant account/profile.
Merchant ID
The unique username for that operator.
Password
Must be at least eight characters long, contain at least one alphabetical character and numeric character and is case-sensitive.
GATEWAY REPORT SEARCH PAGE TERMS Use the fields on the Gateway Report search page to enter the search parameters for your order The search parameters are as follows:
From/To
Search for orders within a date range. If you clear the From field, all transactions up to the current date are displayed. The default From and To Dates are at the date of the user’s local time zone.
Time Interval
The time span that the transactions occurred for example: Daily, Weekly, Monthly, Yearly. If a two-week period is entered with a daily time interval, 14 daily report totals are displayed.
Currency
Search for transactions processed in a specific currency or all currencies.
Date
The start date of the period for which transactions are aggregated.
Acquirer
The name of the acquirer who processed the transactions.
40
SPGS - Merchant Administration User Guide
Merchant ID
The merchant’s unique alphanumeric identifier. There is a unique Merchant ID for each merchant account/profile.
No. Transactions
The number of transactions that were settled during the reporting period.
Total Authorizations
The total amount (specified using the currency and the currency symbol) of authorizations, less any voids or refunds in, the reported transactions.
Total Captures
The total amount (specified using the currency and the currency symbol) of captures, less any voids or refunds, in the reported transactions.
Total Purchases
The total amount (specified using the currency and the currency symbol) of purchases, less any voids or refunds, in the reported transactions.
Total Refunds
The total amount (specified using the currency and the currency symbol) of refunds in the reported transactions.
TRANSACTION FILTERING (TRUSTED & SUSPECT CARDS) TERMS Card Number
The credit card number of the card holder.
Card Holder Name
The name of the card holder. This is an optional field. Note: The card holder name cannot exceed 40 characters.
Reason
The reason for which you wish to add the specified card number as a trusted card number. This is an optional field. Note: The reason cannot exceed 40 characters.
SPGS - Merchant Administration User Guide
41
42
SPGS - Merchant Administration User Guide
SPGS - Merchant Administration User Guide