Lay-Buys Payment Gateway Extension€¦ · Step 3: Installing “Lay-Buys Payment Gateway Extension...

Copyright LAY-BUYS (2011). (http://lay-buys.com/)

User Guide: Lay-Buys Payment Gateway Extension for Magento Support: http://lay-buys.com

|

Lay-Buys Payment Gateway Extension

Magento Extension User Guide

Copyright LAY-BUYS (2011). (http://lay-buys.com/) 1. How to Install


Table of contents:

1. How to Install…………………………………………………..…….……………………….3 2. General Settings…………………………………………………..………………………….6 3. Use as Payment option.…………..………………………………………………….…….8 4. Lay-Buys Installment Reports...………….……………………………………….…..10 5. Fetch Updates...…………………..………………………………………….………….…..13 6. View Transaction Details …………………….………………….………………….……14 7. Cancel Transaction ………...………….…………………………………….……….…...16 8. Revise Installment Plan ………...…………….…………………………..……….….…17 9. Transaction Statuses …………..….……….……………………………..……..….……22



Lay-Buys payment solution is easy to install on Magento c0mmunity.

Admin has to perform following Steps:

1. Download “Lay-Buys Payment Gateway Extension For Magento” from lay-buys.com 2. Register at https://lay-buys.com/ as merchant 3. Installing “Lay-Buys Payment Gateway Extension for Magento”

Step 1: Download User guide for “Lay-Buys Payment Gateway Extension

for Magento”

• Download the user guide from http://www.lay-buys.com

Step 2: Register at lay-buys.com as merchant • Sign-up on https://lay-buys.com/vtmob/register.php



• Then fill your PayPal credentials (see account page)

• And note down your Member ID

Step 3: Installing “Lay-Buys Payment Gateway Extension for Magento”

• The easiest way to install the plug-in is by using “magento connect”, in the admin section go to

“System -> Magento Connect -> Magento Connect Manager”, you will be prompted for your

magento’s user and password, log in.

• Then in the section “Direct package file upload” in the section “Browse” the downloaded

package name as “Ced_LayBuy-0.1.0.tgz” and click “Upload”.



• A console will inform you of the installation progress the message would be like this

• Click on “Refresh” button and then return to “admin panel”

• Now your Lay-Buys Payment Gateway is ready to use.


2. General Settings


Page7 |

Please go to admin panel -> System -> Configuration -> Payment Methods -> Lay-Buy Payment Gateway to manage the payment method settings.


2. General Settings


Page8 |

Field-wise description:

� Enabled field toggle the payment method availability for checkout step at magento shopping cart.

� Title is the label of payment method widely used in various location in magento core functionality like in order.

� New Order Status is the order status for newly created order using this payment extension.

� Gateway Url is the POSTing url for process order payment, provided with extension kit. This URL is always

http://lay-buys.com/gateway/

� Lay-Buys Membership Number is a unique id provided from lay-buys.com on a merchant account creation.

� Line Items Description is enable the description of all the items from order.

� Minimum is the minimum down payment percentage allowed for a down payment.

� Maximum is the maximum down payment percentage allowed for a down payment.

� Months field is the maximum cycle for payment installment.

� Image/Logo is the field for logo or image to appear on Lay-Buys page for your branding or white-labeling

� Payment Applicable From is for managing the country specific availability of this payment method.

� Sort Order is the displaying order among all the payment methods at “Payment Method” step in checkout steps.

� Installment Report Setting

o Api Credentials

� Api IP-Address is the url for fetching the installment report from lay-buys server, provided with this

payment extension. This address is always https://lay-buys.com/report/

o Scheduled Fetching

� Enable Automatic Fetching is enable the automatic fetching the installment reports (Cron Jobs must be

enabled at server).

� Schedule is the frequency of automatic fetching.


2. General Settings


Page9 |

� Time of Day is the time when automatic fetching run on server through Cron Jobs.

� Enable Express Checkout :

o Enabled is used to enable Express Checkout Functionality.

Note: When Express Checkout functionality will enable, a button will show at Product View and Cart page of

the merchant site as shown in images below: -

Fig: Product View Page Fig: Cart Page


2. General Settings


Page10 |

By clicking on “PUT IT ON LAY-BUY powered by PayPal” it will redirect on “Payment Plan Selector” page from

where buyer has to choose the preferred instalment plan as shown in figure.

Fig: Payment Plan Selector Page

After selecting the payment plan buyer has to click on “Continue” button in order to make payment. This will

redirect to PayPal payment page for initiating the down-payment but final payment will only be calculated and paid after

completing the “Review Order Form” page. (So shipping cost will then be added, if there is a shipping cost on order)


2. General Settings


Page11|

At “Review

Order Form”

page buyer has to

choose shipping

carriers and rates

for that order, then

buyer has to click

on “Place Order”

button form

confirming the

payment and order

data. If there is any

changes in

addresses then

buyer has to click

on “Update Order

Data” before click

on “Place Order”.

Fig: Review Order Form Page

Copyright LAY-BUYS (2011). (http://lay-buys.com/) 3. Use as Payment Option


|

At Checkout Page in Magento Front-end:

Payment Information Step

Lay-Buys Payment method appears in checkout step when a

buyer checks out the order.

When a customer chooses Lay-Buy payment method as their

payment option in payment step under checkout page, then

customer has to choose the installment plan for his/her

payment by choosing a down payment percentage and months for

creating installment payment for 1, 2 or 3 months.

On changing the options you see the Plan Preview table will also

change with a view displaying your installment plan with the down payment amount and what will be the next payments

dates and what will be the next payments amounts.

There is a help link What is LAY-BUY? on clicking a tool tip will appear with an explanatory statement for

Lay-Buys payment method.

Copyright LAY-BUYS (2011). (http://lay-buys.com/) 3. Use as Payment Option


|

Order Review Step

Lay-Buys installment plan also appears in Order Review step.

Instead of one single “Place Order” button, there are two

buttons that appear in this step, first one is “Put it on Lay-

Buy” and second one is “Place Order”. When customer

chooses the Lay-Buys as their payment option in Payment

Information Step at checkout page.

Both buttons serve same purpose that is place an order on Magento website and then redirect to PayPal for payment.

Instead of paying all the amount (grand total of order), customer only pays the down payment amount and then a

recurring profile is created in PayPal for next payments.

On successful payment a success page appears at Magento website by showing success information and on failure a

Magento order will be cancelled and show a failure page with error message.

Copyright LAY-BUYS (2011). (http://lay-buys.com/) 4. Lay-Buys Installment Reports

| P a g e


Lay-Buys Installment Reports are the transaction reports which contain all the information related to Lay-Buys

detail, PayPal transaction detail, customer detail, order detail and installment detail. When a customer chooses Lay-Buys

payment option as their payment method in payment step under checkout page, then customer has to choose the

installment plan for his/her payment by paying a down payment and an installment payment for 1, 2 or 3 months.

So every transaction is stored in Magento admin and can be managed form a panel called “Lay-Buys Installment

Reports”.

Please go to admin panel -> Reports -> Sales -> Lay-Buy Installment Reports


| P a g e


The “Lay-Buy Installment Reports” panel list as a table and every transaction as a row.


| P a g e


Column-wise description:

� Created At is a date time field and store the created date of transaction.

� Order# is the order id related with the transaction.

� Amount is the grand total of order.

� Down Payment % is the percentage of down payment.

� Months is the total no of installment cycles.

� Downpayment Amount is the down payment amount (calculated from down payment %) paid at time of order

placing.

� Payment Amounts is the next installments amount.

� First Payment Due is the date of first payment.

� Last Payment Due is the date of last payment.

� Status is the status of transaction. It may be Pending/Completed/Cancelled/Revised Request/Revised

When a transaction have pending installments then its status will be “Pending” , if transaction have no pending

installments means all installments get paid then its status will be “Completed”. If transaction is cancelled due to

some reason then its status will be “Canceled”.

Admin can revise the installment plan by sending a request mail to the buyer, so when a transaction is just requested

then its status will be “Revise Requested” when buyer accepts and processes the transaction then its old transaction

gets a status of “Revised” and a new transaction row will appear for same order with a status “Completed/Pending”.

Detailed explanation about Status is discussed in next topics.

Copyright LAY-BUYS (2011). (http://lay-buys.com/) 5. Fetch Updates

| P a g e


Fetch Updates is the functionality for fetching the latest report of installments from http://lay-buys.com.

At “Lay-Buy Installment Reports” panel, there is a button at top-right corner named as “Fetch Updates”.

Fetch Updated send a request for all transactions which have Pending status. So when admin click on “Fetch

Updates” a confirm pop up will appear as:

Then Click on “Ok” for proceed otherwise you can stop the fetching process by clicking on “Cancel”.

On success there will be a success message appeared with total fetched count at message area as:



| P a g e

6. View Transaction Details

View Transaction Details of a transaction is the detail page of the transaction. If admin wantS to see the complete

detail of transaction then admin has to click on the appropriate row from “Lay-Buy Installment Report” table (grid).

The detail page will look like this:



| P a g e

6. View Transaction Details

Field-wise description:

� Reference Information :

� PayPal Profile ID is the recurring profile ID from PayPal.

� Lay-Buy Reference ID is unique ID from Lay-Buy related to current transaction.

� Order ID is the order ID related to current transaction.

� Payment Plan :

� Amount is the grand total of order.

� Down Payment % is the percentage of down payment.

� Months is the total no of installment cycles.

� Downpayment Amount is the down payment amount (calculated from down payment %) paid at time of

order placing.

� Payment Amounts is the next installments amount.

� First Payment Due is the date of first payment.

� Last Payment Due is the date of last payment.

� Payment Record is a tabular information about down payment and its installments with date, transaction ID

and status. Status may be Completed/Pending/Cancelled.

� Customer Information :

� First Name is first name of customer.

� Last Name is last name of customer.

� Email is email of customer.

� Address is address of customer.

� Suburb is suburb of customer.

� State is state of customer.

� Country is country of customer.

� Postcode is postcode of customer


7. Cancel Transaction


| P a g e

Cancel Transaction is the functionality of cancelling the current recurring profile form Lay-Buys through

PayPal as well as cancelling the associated order in Magento admin.

For “Cancel Transaction”, there is a button at “View Transaction Details” page, “Cancel Transaction”.

So admin can click on this for cancelling the order and its recurring profile from Lay-Buys and PayPal.

Note: Only a Pending Transaction can be cancelled.


8. Revise Installment Plan


| P a g e

Revise Installment Plan is the process of editing the current installment plan. This functionality creates a new

transaction row with revised plan. For revising you can click on “Revise Installment Plan” button on “View

Transaction Details” page. After clicking on that button a form will open with editing options as:

Note: Only a Pending Transaction can be revised.




| P a g e

The Revise form contains information that is editable and read-only. Reference Information doesn’t need to be

edited so these fields are read-only and these fields are used for reference on revising process.

Total Amount is the amount available for revising process, generally it’s calculated by formula

Total Amount = Grand Total of order – Total Paid Amounts

Where, Total Paid Amounts = Down Payment + (no of completed installment * Payment Amounts)

Payment Type is the method of next payment. It may be Lay-Buy or Buy-Now.

� Lay-Buy: It creates a new recurring profile for balance amount outstanding. And cancels the current profile.

� Buy-Now: It’s the method of paying full balance amount at one time without any installment plan. So when

customer wants to pay entire balance amount today, then admin can choose this method for customer.

Initial Payment* is the down payment percentage for new plan.

Months to Pay * is the no of installment cycles for new plan.

Preview* is the preview of your plan depend upon Initial Payment and Months to Pay fields.

Email (read only) is the email of customer. It must be same throughout Magento, Lay-Buys and PayPal. And it is an

important key to identify the customer data on Lay-Buys and PayPal so it can’t be changed from here.

*visible on “Lay-Buy” option, if “Buy-Now” will choose these fields get disappeared because in Buy-Now is the

one-time payment method - so no need of installment information.




| P a g e

After choosing new plan click on “Save and Send Email to Buyer” button for submit the request and send a

mail to the customer’s email. Also current transaction status become “Revise Requested”. After success a message

will appear with message “Request was saved and email sent to <customer_email> for order<order_id>”.

According to “Payment-Type” the processing of revising will works.

Progress for “Lay-Buy” Method:

� Email Structure: see example format




| P a g e

In mail content there will be a link for accepting revise request and pay the new down payment from PayPal.

When customer clicks on the link they will be redirected to PayPal to perform the transaction. After success,

customer is redirected to Magento success page and a new transaction row is added to transaction table with

Status “Pending”.

Progress for “Buy-Now” Method:

� Email Structure: see example format




| P a g e

In mail content there will be a link for accepting revise request and to pay the balance amount from PayPal

immediately. When customer clicks on the link they will redirected to PayPal to perform the transaction. After

success, customer is redirected to Magento success page and a new transaction row will be added to transaction

table with Status “Completed”.


9. Transaction Statuses


| P a g e

There are five kind of transaction statuses as:

1. Pending,

2. Completed,

3. Cancelled,

4. Revise Requested, and

5. Revised.

Pending when at least one installment is pending.

Completed when all the installments have been paid or revised by Buy-Now method.

Cancelled when all installments have not been paid, and order cancelled by admin as “Cancel Transaction”.

Revise Requested when a payment plan is revised and awaiting customer to complete payment in PayPal.

Revised when customer responds to Revise Request, transaction then old transaction become Revised.



| P a g e

Thank you!

Should you have any questions or feature suggestions, please contact us at:

http://lay-buys.com

Your feedback is absolutely welcome!

Lay-Buys Payment Gateway Extension€¦ · Step 3: Installing “Lay-Buys Payment Gateway Extension...

Documents

Transcript of Lay-Buys Payment Gateway Extension€¦ · Step 3: Installing “Lay-Buys Payment Gateway Extension...