PHPackages                             ratepay/shopware5-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. ratepay/shopware5-module

ActiveShopware-plugin[Payment Processing](/categories/payments)

ratepay/shopware5-module
========================

Ratepay payment methods for Shopware 5

7.0.0(4y ago)1126MITPHPPHP ^5.6 || ^7.0 || ^8.0CI failing

Since Oct 21Pushed 2y ago5 watchersCompare

[ Source](https://github.com/ratepay/shopware5-module)[ Packagist](https://packagist.org/packages/ratepay/shopware5-module)[ RSS](/packages/ratepay-shopware5-module/feed)WikiDiscussions 7.0 Synced today

READMEChangelog (10)Dependencies (2)Versions (28)Used By (0)

Ratepay GmbH - Shopware Payment Module
======================================

[](#ratepay-gmbh---shopware-payment-module)

============================================

ModuleRatepay Module for ShopwareShop Version`5.5.0` - `5.7.x`LinkMailFull Documentation[click here](https://docs.ratepay.com/docs/developer/shop_modules/shopware/shopware_5/ratepay_payment_plugin_for_shopware/)Legal Disclaimer[click here](https://docs.ratepay.com/docs/developer/shop_modules/overview/)Installation
------------

[](#installation)

### via packagist (recommended)

[](#via-packagist-recommended)

This is only possible if you use the [composer setup of shopware](https://developers.shopware.com/developers-guide/shopware-composer/)

1. execute `composer require ratepay/shopware5-module` in your project directory
2. Log into your Shopware-backend
3. Install & configure the module

### via Shopware store (or GitHub [release download](https://github.com/ratepay/shopware5-module/releases))

[](#via-shopware-store-or-github-release-download)

1. Download the plugin from the [Shopware store](https://store.shopware.com/rpay00625f/ratepay-payment-plugin-for-shopware-5.html)
2. Upload it via the Plugin Manager or put it into the folder `custom/plugins/RpayRatePay`
3. Log into your Shopware-backend
4. Install & configure the module

Changelog
---------

[](#changelog)

please have a look into plugin.xml

Shopware CLI Commands
---------------------

[](#shopware-cli-commands)

You can use the Shopware CLI to perform operations on Ratepay orders.

All commands have the same structure:

```
./bin/console ratepay:  [] []

```

NameDescriptionrequired`operation`one of `deliver`, `return`, `cancel`Yes`order`the `order id`, `order number` or the ` transaction id` of the orderYes`orderDetail`the `detail id` or `detail number` which has to be performed. If not provided, all items of a order will be selected.
Use `shipping` to perform the action on the shipping costs.No`qty`the quantity which has to be performed. If not provided, the original ordered quantity will be usedNo### example operation `deliver`

[](#example-operation-deliver)

all elements of the order (with the id `125`) will be delivered

```
./bin/console ratepay:deliver 125

```

### example operation `return`

[](#example-operation-return)

`2` elements with item-number `SW0001` of the order (with the transaction-id `54-214XXXXXX2133`) will be returned

```
./bin/console ratepay:return 54-214XXXXXX2133 SW0001 2

```

### example operation `cancel`

[](#example-operation-cancel)

all elements with item-number `SW0001` of the order (with the order-number `200012`) will be canceled

```
./bin/console ratepay:cancel 200012 SW0001

```

Request services
----------------

[](#request-services)

There are a three request services registered in the container:

- `\RpayRatePay\Services\Request\PaymentDeliveryService`

    Use this service to do deliveries for order.
- `RpayRatePay\Services\Request\PaymentReturnService`

    Use this service to do returns for order.
- `RpayRatePay\Services\Request\PaymentCancelService`

    Use this service to do cancellations for order.

### Usage of the request services

[](#usage-of-the-request-services)

Get the request service via dependency injection. The id of the service is the classname (symfony 3 style)

#### perform just a few products

[](#perform-just-a-few-products)

```
use \RpayRatePay\DTO\BasketPosition;

$orderDetail = [ instance of \Shopware\Models\Order\Detail ]
$order = [ instance of \Shopware\Models\Order ]

$basketPosition = new BasketPosition($productNumber, $qty);
$basketPosition->setOrderDetail($orderDetail);
$basketPositions[] = $basketPosition;

$basketPosition = new BasketPosition($productNumber, $qty);
$basketPosition->setOrderDetail($orderDetail);
$basketPositions[] = $basketPosition;

[...]

$basketPositions[] = new BasketPosition(BasketPosition::SHIPPING_NUMBER, 1);

$requestService->setItems($basketPositions);
$requestService->setOrder($order);
$response = $requestService->doRequest();

```

If you want to deliver/cancel/return the shipping costs of an order, you need to provide `shipping` as a string as `$productNumber`. The `$qty` must be `1`. You must not call `setOrderDetail()` on the `$basketPosition`.

Please note that you always have to call `setOrderDetail()` if you want to deliver/cancel/return a product or voucher, except the shipping costs.

#### perform full action

[](#perform-full-action)

If you want to do a full deliver/cancel/return, just call the following:

```
$order = [ instance of \Shopware\Models\Order ]
$response = $requestService->doFullAction($order);

```

(already delivered/returned/canceled items will be ignored.)

### Response

[](#response)

you will get an `\RatePAY\Model\Response\AbstractResponse` or a boolean as response.

If you get an `AbstractResponse`, just call `isSuccessful()` to verify if the request was successful.

If you get a boolean with the value `true` the operation has been registered to in the database, but has not been sent to the gateway. This will happen, if the order is an installment and there an open (not delivered/canceled) items in the order.

Feature flags
=============

[](#feature-flags)

You can enable specific features by setting the flags in the plugin configuration.

\*Please note: \*You should test each feature very carefully, because they may break your processes in some cases.

Please contact your contact person to make sure that this feature will work in your installation.

Separate the features with a comma and no spaces.

FlagDescriptionFEATURE-4465The PaymentRequest against the gateway sends all items from the BASKET. The ConfirmationDeliver-Request will send all items from the ORDER. So if there is any extension which will add new line-items during the save of the order, the plugin tries to deliver the items during the ConfirmationDeliver request. This feature compares the items, which are in the order and in the basket. Enabling this means, that items, which are not in the basket (but saved to the order), will not saved as ratepay position and can not be delivered. You should also enable FEATURE-8543 if you have enabled the bidirectionality.FEATURE-8543By default, if an ratepay position can not be found during an order status update (bidirectionallity), an exception will be thrown and the order will be not updated. If this flag is enabled, the other positions of the order will be processed (if there any). A warning will be reported to the log file. This flag will also work for single order position update during bidirectionality.

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community23

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~58 days

Recently: every ~152 days

Total

19

Last Release

1026d ago

Major Versions

5.5.1 → 6.0.0-alpha12020-10-24

5.5.x-dev → 6.0.02021-02-08

6.2.x-dev → 7.0.02022-04-12

PHP version history (3 changes)5.5.1PHP ^5.6

6.0.0-alpha1PHP ^5.6 || ^7.0

6.1.0PHP ^5.6 || ^7.0 || ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/0a7707a82959d2e36bc1f3aef714ed45ee68fc5600b9cb393dbabcabdaf22bf6?d=identicon)[ratepay](/maintainers/ratepay)

![](https://www.gravatar.com/avatar/5a90bcfb9daf0fd7cb93ef1449e706f86ef33f0ad304f5305aa395b59da70e75?d=identicon)[webidea](/maintainers/webidea)

---

Top Contributors

[![rommelfreddy](https://avatars.githubusercontent.com/u/15031079?v=4)](https://github.com/rommelfreddy "rommelfreddy (266 commits)")[![AnnegretS](https://avatars.githubusercontent.com/u/22612471?v=4)](https://github.com/AnnegretS "AnnegretS (167 commits)")[![rpWhittington](https://avatars.githubusercontent.com/u/39960679?v=4)](https://github.com/rpWhittington "rpWhittington (121 commits)")[![eiriarte-mendez](https://avatars.githubusercontent.com/u/39985982?v=4)](https://github.com/eiriarte-mendez "eiriarte-mendez (85 commits)")[![rpWelschlau](https://avatars.githubusercontent.com/u/26767571?v=4)](https://github.com/rpWelschlau "rpWelschlau (80 commits)")[![soerenmartius](https://avatars.githubusercontent.com/u/930643?v=4)](https://github.com/soerenmartius "soerenmartius (44 commits)")[![MTroesken](https://avatars.githubusercontent.com/u/40829364?v=4)](https://github.com/MTroesken "MTroesken (39 commits)")[![MartinKuhl](https://avatars.githubusercontent.com/u/55736453?v=4)](https://github.com/MartinKuhl "MartinKuhl (10 commits)")[![SimonZachrau](https://avatars.githubusercontent.com/u/49482115?v=4)](https://github.com/SimonZachrau "SimonZachrau (5 commits)")[![schmittrigger](https://avatars.githubusercontent.com/u/3489968?v=4)](https://github.com/schmittrigger "schmittrigger (3 commits)")[![vlkrrhmlw](https://avatars.githubusercontent.com/u/5909041?v=4)](https://github.com/vlkrrhmlw "vlkrrhmlw (1 commits)")[![KevinHansen23](https://avatars.githubusercontent.com/u/45963936?v=4)](https://github.com/KevinHansen23 "KevinHansen23 (1 commits)")[![Jessica2342](https://avatars.githubusercontent.com/u/35141956?v=4)](https://github.com/Jessica2342 "Jessica2342 (1 commits)")

---

Tags

direct-debitecommerceinstalmentsinvoicepaymentpayment-integrationprepaymentshopware

### Embed Badge

![Health badge](/badges/ratepay-shopware5-module/health.svg)

```
[![Health](https://phpackages.com/badges/ratepay-shopware5-module/health.svg)](https://phpackages.com/packages/ratepay-shopware5-module)
```

###  Alternatives

[msilabs/bkash

bKash Payment Gateway API for Laravel Framework.

181.2k](/packages/msilabs-bkash)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)