README

Paytrail payment service for Adobe Commerce (formerly known as Magento 2)

WARNING: This module is not compatible with Markup/Paytrail module. Using both modules will cause errors.

Always perform a backup of your database and source code before installing any extensions.

This module has been tested on Adobe Commerce / Magento 2.4.5, 2.4.4 and 2.3.X {community|commerce} versions. Support for 2.2.X has ended and compatibility with older versions cannot be guaranteed.

Adobe Commerce system requirements per tested version can be found here.

Features

This payment module has the following features:

Payment methods provided by Paytrail payment service
The ability to restore and ship a cancelled order
Support for delayed payments (Collector etc.)
Support for multiple stores within a single Magento 2 instance
Recurring Payments

Installation

The module only supports installation via composer.

Steps:

Make sure that you have Magento file system owner rights.
Navigate to your Adobe Commerce root folder on the command line and enter:
composer require paytrail/paytrail-for-adobe-commerce:<latest_version> --no-update
If your credentials are asked, enter your Adobe Commerce marketplace access keys.
Enter command:
composer update paytrail/paytrail-for-adobe-commerce
Run the following commands:
php bin/magento module:enable Paytrail_PaymentService
php bin/magento setup:upgrade
php bin/magento setup:di:compile
bin/magento setup:static-content:deploy
Navigate to Adobe Commerce admin interface and select Stores -> Store Configuration -> Sales -> Payment Methods -> Paytrail for Adobe Commerce
Enter your credentials and enable the module (Test credentials)
Clear the cache

Usage

The module settings can be found from: Stores -> Configuration -> Sales -> Payment Methods -> Paytrail for Adobe Commerce

The module has the following settings:

Enable: Defines whether the payment method is enabled or not (Input: Yes / No)
Payment method selection on a separate page: Display payment method selection on a separate page (Input: Yes / No)
Merchant ID: Your Paytrail merchant ID (Input: Text)
Merchant Secret: Your Paytrail merchant secret (Input: Secret)
New Order Status: A custom status for a new order paid for with Paytrail (Input: Selection)
Email Address For Notifications: If a payment has been processed after the order has been cancelled, a notification will be sent to the merchant so that they can reactivate and ship the order (Input: Email address)
Payment from Applicable Countries: Allow payments from all countries or specific countries (Input: All / Specific)
Payment from Specific Countries: If the previous setting has been set to specific countries, this list can define the allowed countries (Input: Selection)

Setting up Recurring Payments

The module now supports recurring payments. Please refer to the full instructions on Recurring Payments to set it up.

Refunds

This payment module supports online refunds.

Steps:

Navigate to Sales -> Orders and select the order you need to fully or partially refund
Select Invoices from Order View side bar
Select the invoice
Select Credit Memo
Define the items you want to refund and optionally define an adjustment fee
Click Refund

Canceled order payment email notification

If the customer closes the browser window right after completing the payment BUT before returning to the store, Adobe Commerce is left with a “Pending payment” status for the order. This status has a timeout, so if the payment confirmation does not arrive within 8 hours of the purchase, Adobe Commerce automatically cancels the order. Paytrail informs Adobe Commerce of a payment that has gone through, but it may take over 8 hours.

When the confirmation is finally made, Adobe Commerce registers the transaction to the order and changes the order status to Processing. But since the stock may have changed in the interim, the items are still cancelled. The merchant will receive an email informing about the payment that has gone through, but they have to manually go to said order, make sure the items are still available, and click “Restore order” to be able to ship it.

Adjust the timeout
The timeout period of 8 hours can be adjusted in Adobe Commerce configuration. A longer period may allow for Paytrail to confirm the order before it gets canceled, but it also reserves the stock for that exact time.

Go to Stores -> Configuration -> Sales -> Sales -> Orders Cron Settings
Adjust the Pending Payment Order Lifetime (minutes) value to your liking.

Order status

Pending Payment
Assigned to an order when customer is redirected to the payment provider of their choosing.

Pending Paytrail Payment Service
Assigned to an order if Paytrail for Adobe Commerce is still waiting for a confirmation of payment. Applies to invoices, such as Collector.

Processing
Assigned to an order once payment is completed and items are ready for shipping.

Canceled
Assigned to an order if Pending Payment status has been active for over 8 hours.

Available statuses:

Processing
Suspected Fraud
Pending Payment
Pending Paytrail Payment Service
Payment Review
Pending
On Hold
Complete
Closed
Canceled

Multiple stores

If you have multiple stores, you can set up the payment module differently depending on the selected store. In configuration settings, there is a selection for Store View.

By changing the Store View, you can define different settings for each store within the Adobe Commerce instance.

Rounding problems with certain providers (Collector)

In some cases, this module might send a so-called "rounding-row" item in the order data, which might result in an error if this value is negative (this has been observed with Collector payment method). This is related to how Adobe Commerce calculates and rounds taxes and how this module compensates for possible mismatches between the total and sum of individual items.

There are three algorithms for tax calculation in Adobe Commerce which can be set in Stores -> Configuration -> Sales -> Tax -> Tax Calculation Method Based On

Unit Price based
Row Total based
Total based

If the described error occurs when the calculation algorithm is Total based, changing it to Unit Price based might result in tax calculation with no mismatches.

Note: Changing the setting does not mean that the Unit Price based algorithm is better than Total or Row Total based, all three can have rounding issues in certain situations that can be resolved by choosing one of the other algorithms. The algorithms end up with the same calculations majority of the time.

Disclaimer: This open source module is provided to help merchants get started with our payment service. However, we do not offer any warranty or guarantee that the module will work as intended and provide limited support for it. Use at your own risk.

paytrail / paytrail-for-adobe-commerce

Maintainers

Details