put it on lay-buy powered by paypal€¦ · enabled field toggle the payment method availability...

Copyright LAY-BUYS (2011). (http://lay-buys.com/) Status Date: 16-Jan-14

PUT IT ON LAY-BUY powered by PayPal Payment Gateway Extension

Magento Extension User

Guide: version 2.0.0

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

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 Instalment Reports...………….……………………………………….…...11 5. Fetch Updates...…………………..………………………………………….………….…..14 6. View Transaction Details …………………….………………….………………….……15 7. Cancel Transaction ………...………….…………………………………….……….…....17 8. Revise Instalment Plan ………...…………….…………………………..………..….…18 9. Customer Account Section …..….……….……………………………..……..….……23 10. Transaction Statuses …………..….……….…………………….………..……..….……27



Lay-Buys payment solution is easy to install on Magento c0mmunity. Admin have 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 “Lay-Buys Payment Gateway Extension for Magento” • Download the latest package from http://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)


https://lay-buys.com/

http://lay-buys.com/

https://lay-buys.com/vtmob/register.php


• 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.

• Go to section “Install New Extensions” then paste the extension key in “Paste extension key to install” field and click on “Install” button.



• 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.


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

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


Page6

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

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 locations in magento core functionality. New Order Status is the order status for newly created orders using this payment extension. Gateway Url is the POSTing url for process order payment, provided with extension kit. Lay-Buys Membership Number is a unique id provided from lay-buys.com on a merchant account creation. Line Items Description enables 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 monthly QTY cycles for payment instalments. 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 displays order among all the payment methods at “Payment Method” step in checkout steps. Instalment Report Setting

o Api Credentials Api IP-Address is the url for fetching the instalment report from lay-buys server, provided with this

payment extension. o Scheduled Fetching

Enable Automatic Fetching is enable the automatic fetching the instalment reports (Cron Jobs must be enabled at server).

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


Page7

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 will appear in checkout step when a

buyer checks out the order.

When a customer chooses Lay-Buys payment method as their

payment option in payment step under checkout page, then

customer has to choose the instalment plan for his/her payment by

choosing the down payment percentage and QTY months of

instalment payments, being 1, 2 or 3 months to settle balance.

On changing the options you will see the Plan Preview table will also change and show your new instalment plan.

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

Lay-Buys payment method.

Order Review Step

The Lay-Buys instalment plan will then also appear in Order

Review step.



Instead of one single “Place Order” button, two buttons will appear in this step, first one is “Put it on Lay-

Buy” and second one is “Place Order”.

Both buttons server same purpose, on Magento website and basically redirect the customer to PayPal for payment.

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

recurring profile will created in PayPal for the installment payments.

On successful payment a success page will appear on Magento website, by showing success information and on failure a

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



After successful payment from PayPal, admin can view the transactions report at order view page from admin panel

under “Payment Info” section. If any plan was revised, then all the previous and revised plans will also be displayed as a

different table in “Payment Information”

Previous Instalment shows as “Installment Plan” and if there is

any revision of the original plan then all the revised plans will

be displayed as “Revised Instalment Plan1”,

“Revised Instalment Plan2”…

and so on.

For viewing the detail of Instalment plans, admin can click on

these links.


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

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

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

payment option as their payment method, in payment step, under checkout page, then customer can select the instalment

plan for his/her payment by paying a down payment and selecting an instalment payment plan for 1, 2 or 3 months to

pay-off the balance.

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

Reports”.

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



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



Column-wise description: Created At is a date time field and stores the created date of transaction. Order# is the Magento order id related to the transaction. Amount is the grand total of order. Down Payment % is the percentage of down payment. Months is the total no of monthly instalment cycles. Down payment Amount is the down payment amount (calculated from down payment %) paid at time of placing

order. Payment Amounts is the next instalment amounts. 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 has pending instalments, then its status will be “Pending”, if transaction has no pending

instalments and is fully paid, then its status is “Completed”. If a transaction has been cancelled by customer or

merchant, then its status is “Canceled”.

Admin can revise the instalment plan by sending a request mail to buyers. So when a transaction has just been

requested, and the mail has not yet been clicked on by the customer, then its status will be “Revise Requested”. When

customer does accept and process the revised transaction, then old transaction gets a status of “Revised” and a new

transaction row appears for same Magento order ID, with a status “Completed/Pending” (depending if new payment

plan setup then Pending or settled today then Completed).



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

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

Fetch Updates sends a request for all transactions which has Pending status. So when admin clicks on “Fetch

Updates”, a confirm pop- up will appear as:

Then Click on “Ok” to proceed, or you can stop the fetching process by clicking on “Cancel”.

On success a success message will appear, with total fetched count at message area as:


http://lay-buys.com/

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

6. View Transaction Details

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

details of a transaction, then admin has to click on the appropriate row from “Lay-Buy Instalment Report” table (grid).

The detail page looks like:



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 instalment cycles. Downpayment Amount is the down payment amount (calculated from down payment %) paid at time of

order placing. Payment Amounts is the next instalments amount. First Payment Due is the date of first payment. Last Payment Due is the date of last payment. Payment Record is tabular information about down payment and its instalments, 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

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

PayPal as well as cancel the associated order in Magento admin panel.

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

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

The down-payment monies would have already been paid – and a refund would need to be processed between

the merchant and customer less the $25 cancellation fee (unless waived by the merchant)

Note: Only a Pending Transaction can be cancelled.



8. Revise Instalment Plan

Revise Instalment Plan is the process of editing the current instalment plan. This functionality creates a new

transaction row with a revised plan. For revising, you click on the “Revise Instalment Plan” button in “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.




The Revise form contains the some information as editable and some of them are read-only. Reference Information does not need to be editable and these fields are read-only and are used for referencing of revising process. Total Amount is the amount available for revising process, generally it is calculated by formula

Total Amount = Grand Total of order – Total Paid Amounts Where, Total Paid Amounts = Down Payment + (no of completed instalment * 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 outstanding balance amount. And cancels the current profile. Buy-Now: It’s the method for settling the entire outstanding balance amount today via one buy-now payment.

So when a customer wants to pay-off the balance amount today, then admin can choose this method. Initial Payment* is the down payment percentage for new plan. Months to Pay * is the no of instalment cycles for new plan. Preview* is the preview of your plan, showing Initial Payment and Months to Pay fields. Email (read only) is the email of customer. It will be same email address customer uses when paying via PayPal. It is good practice to keep the customer email address the same between Lay-Buys, PayPal and Magento. *visible on “Lay-Buy” option, if “Buy-Now” then field will disappear due to Buy-Now settling the outstanding amount.




After choosing a new plan, click on “Save and Send Email to Buyer” button to submit the request and send a mail to the customer’s email address. Also current transaction status becomes “Revise Requested”. After success a message will appear with message “Request was saved and email sent to <customer_email> for order<order_id>”. Progress for “Lay-Buy” Method: Email Structure: see example format

In mail content there will be a link for customer to accept revise request and pay the new down payment and/or setup recurring payment in PayPal. When customer clicks on the link they will be redirected to PayPal and 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 “Pending” within Magento.




Progress for “Buy-Now” Method: Email Structure: see example format

In mail content there will be a link for accepting the revise request and to settle the outstanding balance amount today from PayPal. When customer clicks on the link they will be redirected to PayPal and 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” in Magento.



9. Customer Account Section

In Customer Account Section, customers can also view their Instalment plans for an order. In “My Orders” section, a customer can view the details of the order by clicking on “View Order”




Then a page will open which shows the orders details. Under “Payment Method” section you can see an anchor link “View Instalment Plan”




If customer wants to see the Instalment details then customer has to click on “View Instalment Plan” link. This link shows all the down payment and Instalment plan history (if any) for this order.




Customer also can view the full details of an Instalment plan by clicking on “View” link in appropriate row.



10. Transaction Statuses

There are five kinds of transaction statuses as:

1. Pending, 2. Completed, 3. Cancelled, 4. Revise Requested, and 5. Revised.

Pending when there is at least one instalment pending within the original or any revised Lay-Buy plans. Completed when product has been paid in full within the original or any revised Lay-Buy plans. There will therefore be no pending instalments outstanding.

Cancelled when an order has been canceled by the merchant or customer. Revise Requested when a transaction has just been revised, email sent to customer for acceptance to Set-up new payment plan or settle outright – but where email has not yet been accepted by customer. Revised when customer has accepted email, made payment & therefore revised the old transaction.



Thank you!

Should you have any questions or feature suggestions, please contact us at: http://www.lay-buys.com/contact/

Your feedback is absolutely welcome!


put it on lay-buy powered by paypal€¦ · enabled field toggle the payment method availability...

Documents