Skip to content

Commit

Permalink
docs: update readme (auto)
Browse files Browse the repository at this point in the history
  • Loading branch information
joaocouto-ifthenpay committed Oct 4, 2024
1 parent 953809a commit 9bdae89
Showing 1 changed file with 64 additions and 3 deletions.
67 changes: 64 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Read this in ![Português](https://github.com/ifthenpay/prestashop8/raw/assets/r
* [Credit Card](#Credit-Card)
* [Payshop](#Payshop)
* [Cofidis Pay](#Cofidis-Pay)
* [Ifthenpay Gateway](#ifthenpay-gateway)

[5. Edit payment details](#Edit-payment-details)
* [Update Payment Data](#Update-Payment-Data)
Expand All @@ -43,7 +44,7 @@ Read this in ![Português](https://github.com/ifthenpay/prestashop8/raw/assets/r
* [Paying order with MB WAY](#Paying-order-with-MB-WAY)
* [Paying order with Credit Card](#Paying-order-with-Credit-Card)
* [Paying order with Cofidis Pay](#Paying-order-with-Cofidis-Pay)

* [Paying order with Ifthenpay Gateway](#paying-order-with-ifthenpay-gateway)


# Introduction
Expand Down Expand Up @@ -75,9 +76,9 @@ See more at [Ifthenpay](https://ifthenpay.com).
# Compatibility

Follow the table below to verify Ifthenpay's module compatibility with your online store.
| | Prestashop 1.6 | Prestashop 1.7 | Prestashop 8 [8.0.0 - 8.1.1] |
| | Prestashop 1.6 | Prestashop 1.7 | Prestashop 8 [8.0.0 - 8.1.7] |
|----------------------------|----------------|----------------|-------------------------------|
| Ifthenpay v8.0.0 -> v8.1.1 | Not compatible | Not compatible | Compatible |
| Ifthenpay v8.0.0 -> v8.2.0 | Not compatible | Not compatible | Compatible |


# Installation
Expand Down Expand Up @@ -257,6 +258,34 @@ Multibanco with Dynamic References payment method generates references by reques
</br>


## Ifthenpay Gateway

* In Modules/Ifthenpay/Configure, click the "MANAGE" button for Ifthenpay Gateway;
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/manage_ifthenpaygateway.png)
</br>

* Configure Ifthenpay Gateway payment method:
1. Activate Callback, by selecting this option the order state will update when a payment is received;
2. Select a Ifthenpay Gateway key. Can only select from the Ifthenpay Gateway keys associated with your Backoffice key;
3. Select a Payment Method Key per each Method and check the checkbox if you want to display it in the gateway page.
4. Select a Payment Method that will be selected in the gateway page by default.
5. (optional) Input a Deadline for gateway page link, from 1 to 99 days or leave empty if you do not want it to expire;
6. Text displayed in the "Return to Shop" button in the gateway page;
7. (optional) Activate Cancel Ifthenpay Gateway Order, by selecting this option, Ifthenpay Gateway orders that are expired 60 minutes after confirmation will have status changed to "Cancelled";
8. (optional) Input minimum order value to only display this payment method for order above it.
9. (optional) Input maximum order value to only display this payment method for order below it.
10. (optional) Select one or more countries to only display this payment method for orders with that shipping country, leave empty to allow all;
11. Display this payment method logo image on checkout, choose from 3 options:
- enabled - default image: displays ifthenpay gateway logo;
- disabled: displays Payment Method Title;
- enabled - composite image: displays a composite image of all the payment method logos you have selected;
12. Text that appears to the consumer during checkout if logo option above is set to disabled.
13. (optional) Input an Integer number to order this payment method in the checkout page. Smallest takes first place.
14. Click "Save" button;
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/config_ifthenpaygateway.png)
</br>


# Edit payment details
**Important Notice:** It is not possible to change to or update to the Credit Card and Cofidis Pay payment methods.
At Prestashop order details, you can edit the order payment method and payment data.
Expand Down Expand Up @@ -428,6 +457,11 @@ to fill the Test Callback form and click the "Test Callback" button (3):
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/cofidis_callback_test.png)
</br>

**Ifthenpay Gateway**: In the backoffice, use the order ID and the order amount, and enter them in the respective fields (1) and (2) of the Callback test form, then click on Test (3).
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/ifthenpaygateway_callback_test.png)

</br>


# Customer usage experience
The following action are described from the perspective of the consumer.
Expand Down Expand Up @@ -569,3 +603,30 @@ The following action are described from the perspective of the consumer.
* After which you will be redirected back to the store;
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/cofidis_payment_return.png)
</br>


## Paying order with Ifthenpay Gateway

* Select Ifthenpay Gateway at checkout and place order:
1. Select "Pay by Ifthenpay Gateway";
2. Check the box of "terms of service" (this will depend on your Prestashop configuration);
3. Click "PLACE ORDER" button;
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/checkout_ifthenpaygateway.png)
</br>

Select one of the payment methods available in the gateway page (1).
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/ifthenpaygateway_payment_1.png)
</br>

In case of Multibanco method, the entity, reference and amount will be displayed.
Here the user can do one of the two:
- in case of an offline payment method, note down the payment details, click the close gateway button (2) and pay later;
- pay at that moment and click the confirm payment button (3) to verify the payment.
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/ifthenpaygateway_payment_2.png)
</br>

If the user did not pay at the moment and did not take note of the payment details, it is also possible to access the Ithenpay Gateway link at a later date in the user account order history or order confirmation email.
![img](https://github.com/ifthenpay/prestashop8/raw/assets/readme_img/en/ifthenpaygateway_payment_3.png)
</br>

You have reached the end of the ifthenpay extension manual for Prestashop 8.

0 comments on commit 9bdae89

Please sign in to comment.