iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If...

28
ISXPAY PAYMENT EXTENSION MAGENTO 2.3 Documentation of Direct Payment Gateway in the Latest Version of Magento

Transcript of iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If...

Page 1: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

ISXPAY PAYMENT EXTENSION

MAGENTO 2.3

Documentation of Direct Payment Gateway in the Latest Version of Magento

Page 2: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

2

Table of Contents

Introduction ............................................................................................................................... 3

Installation Instructions ............................................................................................................. 4

Admin Sign In ............................................................................................................................. 5

Admin Configuration Instructions .............................................................................................. 6

Checkout Workflow ................................................................................................................... 8

Merchant Review Order ............................................................................................................. 9

Merchant Review Invoices and Transactions ............................................................................ 12

Refund Instructions – Admin dashboard .................................................................................. 14

Magento Order Status ............................................................................................................. 17

Customer Requirements .......................................................................................................... 18

Creating an Account ................................................................................................................. 19

Login ........................................................................................................................................ 20

Forgot Your Password .............................................................................................................. 21

Ordering Instructions ............................................................................................................... 22

Orders ..................................................................................................................................... 27

Refunds in Customer Account .................................................................................................. 28

Page 3: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

3

Introduction This is a manual document about the Direct Payment Gateway of Magento. The purpose of this document is to be used as a help tool for understanding “How to integrate/configure with Magento iSXPay PlugIn”. Also, this document provides installation, configuration instructions and information for the procedures of the payment method.

Page 4: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

4

Installation Instructions Magento Deploy ISX Plugin

§ Go to Magento Directory

§ Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.)

Give appropriate rights to the folder and the files inside (with chown command under linux).

Execute the following commands from Magento root folder:

php bin/magento module:enable iSignthis_IsxPay

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy -f

php bin/magento cache:clean

php bin/magento cache:flush

Page 5: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

5

Admin Sign In

All of the instructions in the rest of this guide are written for a user with full administrative privileges, and begin with the assumption that you are logged in to the Admin.

To sign in to the Admin:

In the address bar of your browser, enter the URL that was specified during the installation, followed by the base URL of your store’s Admin. The default Admin URLs look something like this:

http://www.yourdomain.com/admin

Admin Sign In

§ Enter your Admin User Name and Password

§ Click “Login”. Notes: The iSXPay gateway links the merchant account at iSXPay with the merchant’s website, and acts both as a gateway and a merchant account. If you manage multiple Magento websites, you must have a separate iSXPay merchant account for each website.

Page 6: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

6

Admin Configuration Instructions iSXPay Configuration:

§ Login to Magento Admin Page. § On the Admin sidebar, choose Stores. Then under Settings, choose Configuration.

§ In the panel on the left, under Sales, choose Payment Methods.

In the Other Payment Methods section, under Recommended Solutions, click to expand the selection.

In the iSXPay Payment Settings section, enter the following information from your iSXPay account:

iSXPay Configuration

Page 7: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

7

Specify the following fields of configuration:

§ Enabled: set Enabled to “Yes” (To accept payment by iSXPay)

§ Title: iSXPay Payment (Enter a Title to identify the iSXPay payment method during checkout)

§ Workflow: Workflow name (Provided by Merchant support)

§ API Client: API client name (Provided by Merchant support)

§ API Key: Token (Provided by Merchant support)

§ Merchant ID: The merchant ID that is provided by Merchant support

§ Debug: Yes (For testing enable Debug)

§ Payment Action: Authorize & Capture

Set Payment from Applicable Countries to one of the following:

§ Payment From Applicable Countries: “All Allowed Countries” All Allowed Countries: Customers from all countries specified in your store configuration can use this payment method.

§ Payment From Specific Countries Specific Countries: After choosing this option, the Payment from Specific Countries list appears. Select each country in the list where customers can make purchases from your store.

§ Sort Order: Empty When complete, click “Save Config”.

Page 8: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

8

Checkout Workflow

Checkout produce workflow:

§ Customer adds products to cart, and click Proceed to Checkout.

§ During checkout, the customer chooses to pay with the iSXPay Payment Method.

§ The customer enters the card information, and the card is verified. If successful, the order confirmation page appears.

§ Then, click to the Place Order button.

In the final stage of checkout, the customer clicks the Place Order button.

Note: If the transaction fails for any reason, an error message appears on the checkout page and the customer is instructed to try again.

Page 9: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

9

Merchant Review Order

Merchant can log in into the Admin account on the dashboard, to select and view an order with details:

You have access to all of your orders from your account dashboard. Orders can be viewed, tracked, and resubmitted as new orders.

On the Admin sidebar, click Sales and then choose Orders.

To view an order:

Find the order in the grid, and in the Action column, click View.

§ A pending order can be modified, put on hold, canceled, or invoiced and shipped.

§ A completed order can be reordered.

Orders

In the “Information” block, you can see the fields of the response information from the iSXPay.

View Order

Page 10: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

10

Order and Account Information

Order and Account Information

Order Information:

Order Number -The order number appears at the top of the sales order.

Order Date - The date and time the order was placed.

Purchased From - Indicates the website, store, and store view where the order was placed.

Placed from IP - Indicates the IP address of the computer from which the order was placed.

Account Information:

Customer Name - The name of the customer who placed the order. The Customer Name is linked to the customer profile.

Email - The email address of the customer.

Customer Group - The name of the customer group to which the customer is assigned.

Address Information

Address Information

Billing Address - The name of the customer who placed the order, followed by the billing address, telephone number. The telephone number is linked to autodial on a mobile device.

Shipping Address - The address where the order is to be shipped.

Page 11: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

11

Payment and Shipping Method

Payment & Shipping Method

Payment method: Payment Information of iSXPay

Id: The ID for the transaction that is created. Using this ID, you can find more about the transaction in the iSignthis dashboard.

Account number: Credit Card Number

Transaction Date: Transaction Date of the order

Response Code: 00 means successful transaction

Merchant id: The name of the MID.

Transaction id: number of order.

Payment Message: Approved and completed successfully

Currency: The order was placed using USD.

*Note: Orders can be viewed, tracked, and resubmitted as new orders.

Page 12: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

12

Merchant Review Invoices and Transactions

Invoices An invoice is a record of the receipt of payment for an order. Multiple invoices can be created for a single order, each with as many, or as few of the purchased products that you specify. Depending on the payment action, payment can be automatically captured when the invoice is generated.

To invoice an order:

§ On the Admin sidebar, click “Sales” and then choose “Orders”.

§ Find the sales order with the status of “Processing” in the grid. Then, do the following:

§ In the Action column, click the View link.

§ In the panel on the left, choose “Invoices” and then click View to open the specific invoice.

Also, the new invoice page looks similar to a completed order page, with additional fields that can be edited.

Invoices

Transactions

The Transactions grid lists all payment activity that has taken place between your store and a payment system and provides access to more detailed information.

§ On the Admin sidebar, click Sales and then choose Transactions.

§ Find the transaction in the grid. Then, do the following:

§ In the Action column, click the View link.

§ In the panel on the left, choose “Transactions” and then click View to open the specific transaction.

Page 13: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

13

Transactions

Page 14: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

14

Refund Instructions – Admin dashboard All purchases made in your store and processed by iSXPay and can be viewed from the iSXPay dashboard website. If you receive a request for a refund, follow the normal Magento process to issue a credit memo and make a refund. The Credit Memo button appears after a sales order is invoiced.

Credit Memos

A credit memo is a document that shows the amount that is due to the customer for a full or partial refund. The amount refunded to the customer.

The methods that are available to issue refunds depends on the payment method that was used for the order. Orders that were placed using can be refunded to the respective account. Orders that were paid by credit card through a payment gateway can be refunded online, by the payment processor.

To issue a credit memo:

§ On the Admin sidebar, choose Sales. Then on the menu, choose Invoices.

§ Find the completed order in the grid. § Then in the Action column, click the View link to open the order.

§ In the button bar at the top of the page, click Credit Memo.

The button appears only after an order is invoiced.

View Invoice Invoice with Credit Demo

The New Credit Memo page looks similar to the completed order page, with an Items to Refund section that lists each item from the invoice.

Page 15: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

15

To complete the process and generate the credit memo, choose the following online refund button according to the payment method. The payment method used for the order determines that online refund button that are available for a credit memo.

§ Refund Online - If the original purchase was paid by credit card through a payment gateway, the refund

amount is managed by the payment processor. To manage refunds, see the documentation provided by your payment provider.

Scrolling at the bottom of the page you can see the Refund button.

Choose the “Refund” button for iSXPay payment method.

Refund buttons

After of issuing a refund, the following information presented at the page. Items Ordered

Items Ordered

Product: The product name.

Item Status: Indicates the status of the item e.g Refunded.

Original Price: The original catalog price of the item before discounts.

Price: The purchase price of the item.

Page 16: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

16

Qty: The quantity ordered.

Subtotal: The subtotal is the purchase price multiplied by the quantity.

Tax Amount: The amount of tax that applies to the item as a decimal value.

Tax Percent: The percentage of tax applied to this item as a percentage.

Discount Amount: The discount that applies to this item.

Row Total: The line item total, including applicable taxes that are due at the product level, less discounts.

In the Order Total section, do the following:

Order Total

Status indicate the current status of the sales order.

§ Processing § Close § Suspected Fraud

Comment

§ A text box that is used to enter a comment to the customer that accompanies the order.

Notify Customer by Email

§ Mark the checkbox if you want to send the comment to the customer as a separate email.

Visible on Storefront

§ Mark the checkbox if you want the comment to be visible from the customer’s account.

Submit Comment button

§ Submits the comment, and send by email, if applicable.

Page 17: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

17

Magento Order Status

Magento receives response from iSXPay, and sets the order status to one of the following:

Processing - The transaction was successful.

Pending Payment - The system did not receive any response from isxpay.

Canceled - The transaction was not successful for some reason.

Suspected Fraud - The transaction did not pass some of the isxpay fraud filters. The system receives the response from isxpay that the transaction is under review by Fraud Service.

Page 18: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

18

Customer Requirements

§ Customers are signed in to their accounts.

§ Customer accounts have a default billing and shipping address.

§ At least one shipping method is available for the country that is specified in the default shipping address.

§ The following payment method can be used to provide secure access to saved credit card

information: IsxPay

Page 19: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

19

Creating an Account

Anyone can open a free Magento account from our website. The email address that is used to open a Magento account can be associated with only one account.

To create a demo Magento account: Visit the demo Magento site

§ In the upper-right corner, choose “Create an Account”.

Under Personal Information, do the following:

§ Enter your First Name, Last Name and Email Address.

Create an Account

Enter a Password for your demo account. Then, enter it again to confirm.

Magento Account Password Requirements

§ Your Magento password must be from eight to sixteen characters long, and include at least one capital letter, one number, and one special character or one lowercase letter.

When complete, click Submit. Your account dashboard appears.

Page 20: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

20

Login

To log in to your demo Magento account:

Visit the Magento site

Log In

§ In the upper-right corner, click Sign In.

§ Enter the Email address that is associated with your account. Then, enter your Password.

§ When complete, click Sign In.

Page 21: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

21

Forgot Your Password

To receive a new password: If you forget your password, click Forgot Your Password

§ Enter the Email Address that is associated with your account.

§ Enter the CAPTCHA (type the letters and numbers)

Forgot your Password

§ Click on the button Reset My Password. You will receive an email from Magento with a temporary password that you can use to log into your account. Then, reset your password from the dashboard of your account.

Page 22: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

22

Ordering Instructions After the following steps

§ Creation an account § Fill the shipping Information § Adding products to the basket

Clicking on “Proceed to Checkout”.

Checkout Step 1: Shipping step

The first step of the checkout process is for the customer to complete the shipping address information, and to choose the shipping method. If the customer has an account, the shipping address is entered automatically, but can be changed if needed.

The progress bar at the top of the page follows each step of the checkout process, and the Order Summary shows the information entered so far.

Checkout Step 1: Shipping

To ship to a different address:

If there are additional entries in the address book, find the address where the order is to be shipped.

§ Click “Ship Here” to select the address.

Page 23: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

23

To add a new address: At the bottom of the Shipping Address section, click “+ New Address”.

§ Complete the Shipping Address form.

By default, the customer’s first and last names initially appear in the form.

Add a new Shipping Address

All fields are mandatory for successful transaction using valid phone number (+ country code). To save the new address in the address book, mark the checkbox at the bottom of the form. When complete, click Save Address.

Page 24: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

24

New Shipping Address Selected

The new address is now selected as the shipping address.

To choose the shipping method:

In the list of shipping methods, choose the option that you want to use.

Click to the “Next” button, to proceed to the iSXPay payment method.

Page 25: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

25

Checkout Step 2: Review and Payments Step During the second step of the checkout process, the customer chooses the iSXPay payment method. All information can be reviewed, and edited if needed.

Review & Payments

After the selection of iSXPay payment method, you can see the dropdown with the billing information and the direct way to pay through your card type.

iSXPay Payment Method

Page 26: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

26

Customer must their credit card number, Expiration Date and CVV. * Card type logo enables if detects corresponding card number Click to “Place Order” button to complete the transaction. After the transaction completion, customer can see the following screen.

Order Confirmation

The order confirmation appears after the order is placed. The page includes the order number with a link to the customer’s account.

The order confirmation page is also called the “Success” page.

Page 27: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

27

Orders Clicking on the order’s number (link), the page redirect to the “My Orders” page.

Order Created

Page 28: iSXPay Magento DocumentationV1 (1) · § Upload unzipped file in the Magento Path: app/code (If ‘code’ folder does not exist then create one.) Give appropriate rights to the folder

28

Refunds in Customer Account

Customers can track the status of their refunds and verify the balance of their store credit from the dashboard of their accounts.

To view a refund from customer account:

From the storefront, log in into your customer account. Then, do one of the following:

§ Find the order in the list of Recent Orders and click View.

§ In the panel on the left, choose My Orders.

§ Then, find the order in the list and click View.

Click the Refunds tab to view the details of the refund.

View Refund in Customer Account