is-woo-payment-fps/README.md

# Woocommerce Payment Gateway for Hong Kong Faster Payment System (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
```

1. Move the is-woo-payment-fps directory to your wordpress plugins directory.
2. Activate the plugin from the Wordpress admin plugins section.
3. Configure your FPS account details in Woocommerce -> Settings -> Payments -> Hong Kong Faster Payment System (FPS).
4. 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

* Inspiration for the FPS EMV string generation from https://github.com/nessgor/fps-hk-qrcode
* 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

### 1.1
* QR Code quality improved
* Mobile phonen number format example included

### 1.2
* Invalid QR Code problems fixed

### 1.3
* Output QR Code at a higher priority during WP startup
* Form validation for the Payment Gateway settings

### 1.31
* Bug fixes

### 1.4
* Optional QRCode caching added

### 1.41
* Bugfix

### 1.42
* QRCodes always cached to disk due to browser incompatibility issues with dynamic generation.
* Fixed bug preventing headers to be output on some systems

### 1.43
* Minor bug fixes

### 1.44 
* base64 encoded png qrcode

## Donations

Donations are much appreciated if you found this resource useful. 

Bitcoin, Lightning Network and most major credit cards available for donations at [https://frey.hk](https://frey.hk).

## License

This project is licensed under the LGPL 3 License - see the [LICENSE.md](LICENSE.md) file for details
README fixed 2020-07-20 10:12:50 +00:00			`# Woocommerce Payment Gateway for Hong Kong Faster Payment System (FPS)`
License and README update 2020-07-20 10:10:35 +00:00
			`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`
			```

Installation instructions updated 2020-07-26 05:10:29 +00:00			`1. Move the is-woo-payment-fps directory to your wordpress plugins directory.`
			`2. Activate the plugin from the Wordpress admin plugins section.`
			`3. Configure your FPS account details in Woocommerce -> Settings -> Payments -> Hong Kong Faster Payment System (FPS).`
			`4. Enable the Payment Gateway.`
License and README update 2020-07-20 10:10:35 +00:00
			`### 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.`

Layout tweaked 2020-07-22 02:57:30 +00:00			`## Acknowledgements`
License and README update 2020-07-20 10:10:35 +00:00
Acknowledgement added 2020-07-26 05:06:03 +00:00			`* Inspiration for the FPS EMV string generation from https://github.com/nessgor/fps-hk-qrcode`
License and README update 2020-07-20 10:10:35 +00:00			`* 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`

Markup fixed 2020-08-07 06:14:04 +00:00			`### 1.0`
README updated 2020-07-26 05:09:11 +00:00			`* First Release`
License and README update 2020-07-20 10:10:35 +00:00
Markup fixed 2020-08-07 06:14:04 +00:00			`### 1.1`
Version bumped up 2020-07-29 11:04:23 +00:00			`* QR Code quality improved`
			`* Mobile phonen number format example included`

Bumped up version 2020-08-31 07:27:38 +00:00			`### 1.2`
			`* Invalid QR Code problems fixed`

Bumped up version 2020-08-31 11:25:04 +00:00			`### 1.3`
			`* Output QR Code at a higher priority during WP startup`
			`* Form validation for the Payment Gateway settings`

Bumped up version 2020-09-06 13:13:46 +00:00			`### 1.31`
			`* Bug fixes`

Bumped up the version 2020-09-07 02:50:11 +00:00			`### 1.4`
			`* Optional QRCode caching added`

Bugfix 2020-09-07 03:09:10 +00:00			`### 1.41`
			`* Bugfix`

Bumped up version, added release notes 2020-10-14 12:15:30 +00:00			`### 1.42`
Removed dynamic QRCode generation 2020-10-14 12:30:50 +00:00			`* QRCodes always cached to disk due to browser incompatibility issues with dynamic generation.`
Bumped up version, added release notes 2020-10-14 12:15:30 +00:00			`* Fixed bug preventing headers to be output on some systems`

Readme updated 2020-11-20 08:06:57 +00:00			`### 1.43`
			`* Minor bug fixes`

bumped up version 2020-12-24 08:42:41 +00:00			`### 1.44`
			`* base64 encoded png qrcode`

License and README update 2020-07-20 10:10:35 +00:00			`## Donations`

			`Donations are much appreciated if you found this resource useful.`

Update README.md Changed donations section. 2021-04-12 06:43:58 +00:00			`Bitcoin, Lightning Network and most major credit cards available for donations at [https://frey.hk](https://frey.hk).`
License and README update 2020-07-20 10:10:35 +00:00
			`## License`

Update README.md Changed donations section. 2021-04-12 06:43:58 +00:00			`This project is licensed under the LGPL 3 License - see the [LICENSE.md](LICENSE.md) file for details`