Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuutti/commerce_paytrail
https://github.com/tuutti/commerce_paytrail
drupal drupal-commerce drupal-module payment
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tuutti/commerce_paytrail
- Owner: tuutti
- Created: 2016-10-01T18:38:00.000Z (over 8 years ago)
- Default Branch: 4.x
- Last Pushed: 2024-11-20T07:30:20.000Z (about 1 month ago)
- Last Synced: 2024-11-20T07:33:10.057Z (about 1 month ago)
- Topics: drupal, drupal-commerce, drupal-module, payment
- Language: PHP
- Homepage:
- Size: 416 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Commerce paytrail
 [](https://codecov.io/gh/tuutti/commerce_paytrail)
This module integrates [Paytrail](https://www.paytrail.com/en) payment method with Drupal Commerce.
* For a full description of the module, visit the project page:
https://www.drupal.org/project/commerce_paytrail
* To submit bug reports and feature suggestions, or to track changes:
https://www.drupal.org/project/issues/commerce_paytrail
## Installation
Install the Commerce paytrail module as you would normally install a contributed
Drupal module. Visit https://www.drupal.org/node/1897420 for further
information.
## Configuration
1. Configure the Commerce Paytrail gateway from the Administration > Commerce >
Configuration > Payment Gateways (`/admin/commerce/config/payment-gateways`),
by editing an existing or adding a new payment gateway.
2. Select `Paytrail` or `Paytrail (Credit card)` for the payment gateway plugin.
* `Mode`: enables the Paytrail payment gateway in test or live mode.
* `Account`: provide your Paytrail account.
* `Secret`: provide your Paytrail secret.
* `Order discount strategy`: Choose the order discount strategy.
3. Click Save to save your configuration.
## Documentation
### Alter Paytrail API requests/responses
Create an event subscriber that responds to `\Drupal\commerce_paytrail\Event\ModelEvent::class` events:
```php
class YourEventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface {
/**
* Event callback.
*
* @param \Drupal\commerce_paytrail\Event\ModelEvent $event
* The event.
*/
public function processEvent(ModelEvent $event): void {
// See below for all available events.
if ($event->event === \Drupal\commerce_paytrail\RequestBuilder\PaymentRequestBuilderInterface::PAYMENT_CREATE_EVENT) {
// Do something based on event name.
}
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents() : array {
return [
ModelEvent::class => ['processEvent'],
];
}
}
```
See https://www.drupal.org/docs/develop/creating-modules/subscribe-to-and-dispatch-events for more information about events.
### Available events
- Payment requests: [src/RequestBuilder/PaymentRequestBuilderInterface.php](src/RequestBuilder/PaymentRequestBuilderInterface.php)
- Refund requests: [src/RequestBuilder/RefundRequestBuilderInterface.php](src/RequestBuilder/RefundRequestBuilderInterface.php)
- Token payment requests: [src/RequestBuilder/TokenRequestBuilderInterface.php](src/RequestBuilder/TokenRequestBuilderInterface.php)
### Prevent saved payment method from being deleted
```php
/**
* Implements hook_entity_predelete().
*/
function hook_entity_predelete(\Drupal\Core\Entity\EntityInterface $entity) : void {
if (condition) {
throw new \Drupal\commerce_payment\Exception\PaymentGatewayException('Card cannot be deleted').
}
}
```
## Maintainers
* tuutti (tuutti) - https://www.drupal.org/u/tuutti