chris/is-woo-payment-fps
1
0
Fork 0
mirror of https://github.com/invite-frey/is-woo-payment-fps.git synced 2025-04-04 21:40:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

License and README update

Browse Source
This commit is contained in:
Frey Mansikkaniemi 2020-07-20 18:10:35 +08:00
parent 71d79c7fe7
commit f15d5d6e55
2 changed files with 59 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
LICENSE.md
View File

@ -0,0 +1,7 @@
Copyright (c) 2020 Invite Services.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

52
README.md
View File

@ -0,0 +1,52 @@
# Woocommerce Payment Gateway for Hong Kong Faster Payment Syste (FPS)
Woocommerce Payment Gateway for [Hong Kong FPS](https://www.hkma.gov.hk/eng/key-functions/international-financial-centre/financial-market-infrastructure/faster-payment-system-fps/).
Features:
* Generates FPS QR Code based on your Woocommerce payment gateway configuration.
* Automatically include payment reference in the QR Code if your FPS account has "Ask to Pay" feature enabled.
### Prerequisites
* [Wordpress](https://wordpress.org/download/)
* [Woocommerce](https://woocommerce.com)
* An FPS enabled Hong Kong bank account.
### Installation
* Get the files
```
$ git clone https://github.com/invite-frey/is-woo-payment-fps.git
```
* Move the woocommerce-appointments-event-picker directory to your wordpress plugins directory.
* Activate the plugin from the Wordpress admin plugins section.
* Configure your FPS account details in Woocommerce -> Settings -> Payments -> Hong Kong Faster Payment System (FPS).
* Enable the Payment Gateway.
### Configuration
* Title, Description and Payment Reference Guide are the customer facing instructions you can set to anything yo want.
* Account Id Type, Account Id and Bank Code identify the Payee Account. The QR Code is generated based on this information.
* Ask to Pay Enabled: If this feature is enabled, a reference number will be automatically generated and included in the QR Code. You need to contact your bank to use this feature. If this feature is NOT enabled the customer is presented with an automatically generated reference code and asked to enter it when completing the payment using the bank's FPS app.
### Acknowledgements
* The QR codes are generated by [PHP QR Code](https://sourceforge.net/projects/phpqrcode/), which is included under the terms of its [license](https://sourceforge.net/p/phpqrcode/git/ci/master/tree/LICENSE).
## Versioning
* 1.0 - First Release
## Donations
Donations are much appreciated if you found this resource useful.
* Bitcoin: 32AULufQ6AUzq9jKZdcLjSxfePZbsqQKEp
* BTC Lightning via tippin.me: https://tippin.me/@freyhk
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details