https://github.com/paytrail/paytrail-for-adobe-commerce
Paytrail payment service for Adobe Commerce (formerly known as Magento 2)
https://github.com/paytrail/paytrail-for-adobe-commerce
adobe-commerce magento2 paytrail
Last synced: 3 months ago
JSON representation
Paytrail payment service for Adobe Commerce (formerly known as Magento 2)
- Host: GitHub
- URL: https://github.com/paytrail/paytrail-for-adobe-commerce
- Owner: paytrail
- License: mit
- Created: 2021-09-01T10:53:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2026-02-17T06:54:49.000Z (4 months ago)
- Last Synced: 2026-02-17T12:16:17.361Z (4 months ago)
- Topics: adobe-commerce, magento2, paytrail
- Language: PHP
- Homepage: https://www.paytrail.com
- Size: 1.39 MB
- Stars: 3
- Watchers: 6
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Paytrail for Adobe Commerce
[Paytrail](https://www.paytrail.com) payment service for [Adobe Commerce](https://www.magento.com) (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.7, 2.4.6, 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](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html).
## 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](https://github.com/paytrail/paytrail-for-adobe-commerce/wiki/Recurring-Payments)
## Installation
The module only supports installation via composer.
Steps:
1. Make sure that you have Magento file system owner rights.
2. Navigate to your Adobe Commerce root folder on the command line and enter:
```composer require paytrail/paytrail-for-adobe-commerce: --no-update```
3. If your credentials are asked, enter your Adobe Commerce marketplace access keys.
4. Enter command:
```composer update paytrail/paytrail-for-adobe-commerce```
5. 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```
6. Navigate to Adobe Commerce admin interface and select __Stores -> Store Configuration -> Sales -> Payment Methods -> Paytrail for Adobe Commerce__
7. Enter your credentials and enable the module ([Test credentials](https://paytrail.github.io/api-documentation/#/?id=test-credentials))
8. 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](https://github.com/paytrail/paytrail-for-adobe-commerce/wiki/Recurring-Payments) to set it up.
## Refunds
This payment module supports online refunds.
Steps:
1. Navigate to __Sales -> Orders__ and select the order you need to fully or partially refund
2. Select Invoices from Order View side bar
3. Select the invoice
4. Select Credit Memo
5. Define the items you want to refund and optionally define an adjustment fee
6. 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.
1. Go to __Stores -> Configuration -> Sales -> Sales -> Orders Cron Settings__
2. 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
## Setting up Apple Pay
The payment module supports Apple pay payments.
Steps:
1. Enable Apple Pay for your Paytrail Merchant Panel.
2. [Verify your domain with association file](https://docs.paytrail.com/#/?id=verifying-your-domain-with-apple-pay)
3. Enable Apple Pay in admin panel __Stores -> Configuration -> Sales -> Payment Methods -> Apple Pay Configuration__
## 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.
## Payment page UI
Version 2.2.0 provided new UI for payment page. There is no need to use new UI for payment page, old UI is still available when Enable new UI is set to No, as it is by default.
Enable New UI interface in admin panel __Stores -> Configuration -> Sales -> Payment Methods -> Payment Page UI -> Enable new UI__
For the new UI, personalisation options are restricted only to highlight selected payment method and hover on payment method.
## Data Anonymization
If you want to anonymize data from order that is sent to payment provider, you can enable it in admin panel.
Enable Anonymization Order Data in admin panel __Stores -> Configuration -> Sales -> Payment Methods -> Anonymization Order Data -> Enable__
## 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.*