-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README improvements #94
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,26 +3,112 @@ | |
![Build Status](https://github.com/CommerceWeavers/SyliusSaferpayPlugin/actions/workflows/build.yaml/badge.svg) | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
|
||
This plugin adds integration with [Wordline Saferpay](https://www.saferpay.com) to [Sylius](https://github.com/Sylius/Sylius). | ||
![Sylius](docs/img/sylius.png) ![Worldline](docs/img/worldline.png) | ||
|
||
## Content | ||
|
||
1. [Requirements](docs/requirements.md) | ||
1. [Requirements](#requirements) | ||
1. [Overview](#overview) | ||
1. [Features](#features) | ||
1. [About Saferpay](#about-saferpay) | ||
1. [Installation](docs/installation.md) | ||
1. [Configuration](docs/configuration.md) | ||
1. [Development](docs/development.md) | ||
1. [Testing](docs/testing.md) | ||
1. [Cooperation](#cooperation) | ||
1. [License](#license) | ||
1. [About us](#about-us) | ||
|
||
### Requirements | ||
|
||
| Package | Version | | ||
|---------------|---------| | ||
| PHP | ^8.0 | | ||
| sylius/sylius | ^1.10.0 | | ||
|
||
### Overview | ||
|
||
This plugin adds integration with [Worldline Saferpay](https://www.saferpay.com) to [Sylius](https://github.com/Sylius/Sylius). | ||
|
||
### Features | ||
Zales0123 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Saferpay payment method configuration (both test and live environments) | ||
- Payment method transaction logs | ||
- "Debug" mode that allows to log all the logs not only error/failed ones | ||
- Configuration panel to filter which payments should be used with Saferpay | ||
- Webhooks integration for authorization, capture and cancellation | ||
- Refunds with default Sylius refunding process (RefundPlugin integration in the future) | ||
|
||
Checkout: | ||
|
||
![Payments checkout](docs/img/overview/payments-checkout.png) | ||
![Payment logos](docs/img/overview/payment-logos.png) | ||
|
||
Configured Saferpay payment method: | ||
|
||
![Index](docs/img/overview/payment-methods.png) | ||
![Edit](docs/img/overview/edit-form.png) | ||
![Configuration](docs/img/overview/payment-methods-configuration.png) | ||
|
||
Payments logs: | ||
|
||
![Logs](docs/img/overview/logs.png) | ||
|
||
Saferpay panel: | ||
|
||
![Saferpay panel](docs/img/overview/panel.png) | ||
|
||
### About Saferpay | ||
|
||
Saferpay is a modern, all-in-one payment solution, particularly popular in the DACH region due to origins of its | ||
previous owner - SIX Payments - which is a Swiss company acquired by Worldline - a French fintech group. | ||
Saferpay now offers integrations with all major payment methods, incl. local ones like TWINT, major card operators | ||
(VISA, Mastercard), and globally used wallets like ApplePay, GooglePay, PayPal, etc. | ||
|
||
- Free of charge activation of all major means of payment | ||
- Individual payment pages | ||
- Mail-/Phone-Order payments | ||
- Creation and sending of individual payment links | ||
- Acceptance of mobile payments using QR codes | ||
- Payment API & Management API for automation of payments | ||
- Saferpay Backoffice for a complete overview | ||
- Saferpay Risk Management & User Administration | ||
- Saferpay Plugins available for your shop system | ||
- Highest security standards thanks to PCI DSS, PSD2 and 3-D Secure 2 | ||
- Dynamic currency conversion DCC: your international customers pay in their local currency | ||
|
||
### Cooperation | ||
|
||
This plugin was developed in cooperation with [WTG](https://www.wtg.com/) Team. Thank you! | ||
This plugin was sponsored by [WTG Innovation](https://www.wtg.com/innovation) and developed in cooperation | ||
with their Team. Thank you for your contribution to the open-source ecosystem! | ||
|
||
![WTG](docs/img/wtg.png) | ||
|
||
### License | ||
|
||
This plugin's source code is completely free and released under the terms of the MIT license. | ||
|
||
### Security | ||
|
||
If you find anything that could be a security problem, please reach us first on [email protected] | ||
in order to prepare a patch before disclosure. | ||
|
||
### Support | ||
|
||
As plugin creators, we will be happy to help you implement it in your system and maintain it later on. | ||
If you wish to use the free-of-charge community support, make sure to join the [Sylius Slack](https://sylius-community.slack.com/). | ||
We encourage you to use the official Sylius resources to feel more confident in using this plugin: | ||
|
||
- [Sylius Documentation](https://docs.sylius.com/en/latest/) | ||
- [Sylius Online Course](https://sylius.com/online-course/) | ||
- [Sylius Stack Overflow](https://stackoverflow.com/questions/tagged/sylius) | ||
|
||
### About us | ||
|
||
We are [Commerce Weavers](https://www.commerceweavers.com/). For years, we have been [Sylius](https://github.com/Sylius/Sylius) e-commerce framework maintainers | ||
and open-source community leaders. Within this time we have developed our careers and grown fond of each other. | ||
Finally, we have decided to form a new company together. Read more about it in [this article](https://www.linkedin.com/pulse/we-commerce-weavers-commerce-weavers/). | ||
- [Commerce Weavers](https://www.commerceweavers.com/) are the web agency formed by ex-Sylius company members, and long-term core team & community leaders of Sylius - the open-source e-commerce framework based on Symfony, PHP. | ||
- With these origins, we naturally provide services related to all above mentioned technologies - using Sylius, Symfony, and API Platform for various applications development and maintenance. | ||
- We also actively contribute to the open-source community by creating dedicated plugins and visiting tech events. | ||
- We are probably the most active company promoting Sylius on industry meetups - our speakers can be frequently seen at the stages of the biggest PHP & Symfony conferences throught Europe, and beyond. | ||
- In need of training or consulting? We love knowledge sharing and have a proven track record of over 200 trained developers all over Europe. [Get in touch!](https://www.commerceweavers.com/#contact) | ||
|
||
![Commerce Weavers](docs/img/cw.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the checkout screenshot we have the CHF currency, if we use this currency also here, we could probably have more payment methods |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.