mirror of
https://github.com/vr-payment/shopware-6.git
synced 2026-06-04 19:03:01 +00:00
andrewrowanwallee
122 lines
4.4 KiB
Markdown
122 lines
4.4 KiB
Markdown
|
|
|
|
VR Payment Integration for Shopware 6
|
|
=============================
|
|
|
|
## **Overview**
|
|
The VR Payment Payment Plugin integrates modern payment processing into Shopware 6, offering features like iFrame-based payments, refunds, captures, and PCI compliance. It supports seamless integration with the [VR Payment Portal](https://gateway.vr-payment.de/) for managing transactions and payment methods.
|
|
|
|
## Requirements
|
|
|
|
- **Shopware Version:** 6.5.x or 6.6.x (see [compatibility table](#compatibility)).
|
|
- **PHP:** Minimum version as required by your Shopware installation (e.g., 7.4+).
|
|
- **VR Payment Account:** Obtain `Space ID`, `User ID`, and `API Key` from the [VR Payment Dashboard](https://gateway.vr-payment.de/).
|
|
|
|
## Documentation
|
|
- For English documentation click [here](https://docs.plugin-documentation.vr-payment.de/vr-payment/shopware-6/6.2.0/docs/en/documentation.html)
|
|
- Für die deutsche Dokumentation klicken Sie [hier](https://docs.plugin-documentation.vr-payment.de/vr-payment/shopware-6/6.2.0/docs/de/documentation.html)
|
|
- Pour la documentation Française, cliquez [ici](https://docs.plugin-documentation.vr-payment.de/vr-payment/shopware-6/6.2.0/docs/fr/documentation.html)
|
|
- Per la documentazione in tedesco, clicca [qui](https://docs.plugin-documentation.vr-payment.de/vr-payment/shopware-6/6.2.0/docs/it/documentation.html)
|
|
|
|
## Installation
|
|
|
|
### **Via Composer (Recommended)**
|
|
1. Navigate to your Shopware root directory.
|
|
2. Run:
|
|
|
|
```bash
|
|
Copy
|
|
composer require vrpayment/shopware-6
|
|
php bin/console plugin:refresh
|
|
php bin/console plugin:install --activate --clearCache VRPaymentPayment
|
|
```
|
|
|
|
### Manual Installation
|
|
|
|
1. Download the latest [Release](../../releases)
|
|
2. Extract the ZIP to custom/plugins/VRPaymentPayment.
|
|
|
|
```bash
|
|
Copy
|
|
bin/console plugin:refresh
|
|
bin/console plugin:install --activate --clearCache VRPaymentPayment
|
|
```
|
|
|
|
## Update
|
|
|
|
### Via Administration
|
|
1. Go to Shopware Admin > Extensions > My extensions.
|
|
2. Find VRPaymentPayment.
|
|
3. Click Update.
|
|
|
|
### Via CLI
|
|
1. Deploy the new plugin files (replace the folder in custom/plugins/VRPaymentPayment or upload/install a new ZIP).
|
|
2. Run:
|
|
```bash
|
|
bin/console plugin:refresh
|
|
bin/console plugin:update --clearCache VRPaymentPayment
|
|
bin/console cache:clear
|
|
```
|
|
|
|
## Configuration
|
|
### API Credentials
|
|
|
|
1. Navigate to Shopware Admin > Settings > VRPayment Payment.
|
|
2. Enter your Space ID, User ID, and API Key (obtained from the [VR Payment Portal](https://gateway.vr-payment.de/)).
|
|
|
|
### Payment Methods
|
|
|
|
Configure supported methods (e.g., credit cards, Apple Pay) via the [VR Payment Portal](https://gateway.vr-payment.de/).
|
|
|
|
### Key Features
|
|
**iFrame Integration**: Embed payment forms directly into your checkout.
|
|
|
|
**Refunds & Captures**: Trigger full/partial refunds and captures from Shopware or the [VR Payment Portal](https://gateway.vr-payment.de/).
|
|
|
|
**Multi-Store Support**: Manage configurations across multiple stores.
|
|
|
|
**Automatic Updates**: Payment methods sync dynamically via the VRPayment API.
|
|
|
|
## Compatibiliity
|
|
|
|
___________________________________________________________________________________
|
|
| Shopware 6 version | Plugin major version | Supported until |
|
|
|-------------------------------|------------------------|------------------------|
|
|
| Shopware 6.6.x | 6.x | Further notice |
|
|
| Shopware 6.5.x | 5.x | October 2024 |
|
|
-----------------------------------------------------------------------------------
|
|
|
|
### Troubleshooting
|
|
**Logs**: Check payment logs with:
|
|
|
|
```bash
|
|
Copy
|
|
tail -f var/log/vrpayment_payment*.log
|
|
```
|
|
### Common Issues:
|
|
|
|
Ensure composer update vrpayment/shopware-6 is run after updates.
|
|
|
|
Verify API credentials match your VRPayment account.
|
|
|
|
## FAQs
|
|
**Q: Does this plugin support one-click payments?**
|
|
A: Yes, via tokenization in the VRPayment Portal.
|
|
|
|
**Q: How do I handle PCI compliance?**
|
|
A: The plugin uses iFrame integration, reducing PCI requirements to SAQ-A.
|
|
|
|
### Changelog
|
|
For version-specific updates, see the [GitHub Releases](https://github.com/vr-payment/shopware-6/releases).
|
|
|
|
### Contributing
|
|
Report issues via GitHub Issues.
|
|
|
|
Follow the Shopware Plugin Base Guide for development.
|
|
|
|
This template combines technical clarity with user-friendly guidance. For advanced customization (e.g., overriding templates or payment handlers), refer to the Shopware Documentation.
|
|
|
|
## License
|
|
|
|
Please see the [license file](https://github.com/vr-payment/shopware-6/blob/master/LICENSE.txt) for more information.
|