PrestaShop 1.7 introduces a new payment API. Below, you’ll find information about how it works and also, how to migrate your module from PrestaShop 1.6 (and earlier) to PrestaShop 1.7.
The main reason why the change was needed is on the customer side: Now, there is only one button to validate the order, not one by payment module anymore.
To make a payment module for PrestaShop 1.7, you’ll have to respect some elements:
Your class will have to extend PaymentModule.
You will need to declare the following namespace.
use PrestaShop\PrestaShop\Core\Payment\PaymentOption;
You’ll have to register the two following methods: hookPaymentOptions() & hookPaymentReturn() and register these hooks.
You must not have a submit button into your module’s HTML code. It will automatically be generated by PrestaShop.
In the hookPaymentOptions() method, you have to return an array of PaymentOption.
Here is a list of the PaymentOption class variables. They all have a getter and a setter and are accessible in the array sent to the front office template.
You can find a example module illustrating the four identified cases of payment modules on GitHub.
We have identified four cases of payment module in which you can be:
You need to change the payment hook where your module is hooked on by paymentOption. It’s not a display hook anymore, so you must not use the $this->display() method to retrieve a template, but use the $this->context->smarty->fetch() method instead.
Then, implement the hookPaymentOptions() function to return an array of PaymentOption.
Next, you’ll need to identify the type of your payment module to know which variables are mandatory.
What if I can’t remove the submit button?
As you may read it above, you must not have a submit button into your module’s HTML code, because PrestaShop will automatically generate it. If you can’t remove the submit button from the form for some reasons (e.g.: the form is generated by binaries), we have implemented another way to make your module PrestaShp 1.7 compatible. But, note that this is NOT the recommended way to do it.
To do this, you’ll need to implement a supplementary hook: displayPaymentByBinaries. It’s made to display the payment form, and it will replace the unique payment button in the checkout.
You’ll also need to set the $binary variable to true. It will adapt the behavior to hide the payment button and replace it by the form when the payment option is selected.
The parameters passed to the following hooks have been modified:
Key | Value |
---|---|
total_to_pay | result of $order->getOrdersTotalPaid() |
currency | currency sign (string) |
currencyObj | The loaded currency (Currency class) |
objOrder | The current order object (Order class) |
Key | Value |
---|---|
order | The current order object (Order class) |
Everything can be retrieved, for example:
$currency = new Currency($params['order']->id_currency); $total_to_pay = $params['order']->getOrdersTotalPaid(); |
See the bankwire module for an example of how we updated a simple 1.6 module to 1.7: https://github.com/PrestaShop/bankwire/pull/18