forked from bosunolanrewaju/wp-rave-payment-forms
-
Notifications
You must be signed in to change notification settings - Fork 21
/
readme.txt
182 lines (120 loc) · 7.75 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
=== Flutterwave Payments ===
Contributors: flutterwave
Tags: rave, payment form, payment gateway, bank account, credit card, debit card, nigeria, kenya, international, mastercard, visa, flutterwave
Donate link: http://rave.flutterwave.com/
Requires at least: 4.4
Tested up to: 6.3
Requires PHP: 7.4
Stable tag: 1.0.7
License: MIT
License URI: https://github.com/Flutterwave/rave-payment-forms/blob/master/LICENSE
Accept Credit card, Debit card and Bank account payment directly on your WordPress site with the Flutterwave Payments Plugin.
== Description ==
Accept Credit card, Debit card and Bank account payment directly on your store with the official Flutterwave Plugin for WordPress.
= Plugin Features =
* Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, 1voucher.
* Recurring payments: Tokenization and Subscriptions.
* Split payments: Split payments between multiple recipients.
= Requirements =
1. Flutterwave for business [API Keys](https://developer.flutterwave.com/docs/integration-guides/authentication)
2. Supported PHP version: 5.6.0 - 7.4.0
== Installation ==
= Automatic Installation =
* Login to your WordPress Dashboard.
* Click on "Plugins > Add New" from the left menu.
* In the search box type Flutterwave Payments.
* Click on Install Now on Flutterwave Payments to install the plugin on your site.
* Confirm the installation.
* Activate the plugin.
* Go to "Rave > Settings" from the left menu to configure the plugin.
= Manual Installation =
* Download the plugin zip file.
* Login to your WordPress Admin. Click on \"Plugins > Add New\" from the left menu.
* Click on the \"Upload\" option, then click \"Choose File\" to select the zip file you downloaded. Click \"OK\" and \"Install Now\" to complete the installation.
* Activate the plugin.
* Go to \"Rave > Settings\" from the left menu to configure the plugin.
* For FTP manual installation, check here.
For FTP manual installation, [check here](http://codex.wordpress.org/Managing_Plugins#Manual_Plugin_Installation).
= Configuration options =
* Pay Button Public Key (live/Test) - Enter your public key which can be retrieved from Settings > API on your Rave account dashboard.
* Pay Button Secret Key (live/Test) - Enter your secret key which can be retrieved from Settings > API on your Rave account dashboard.
* Go Live - Tick that section to turn your rave plugin live.
* Modal Title - (Optional) customize the title of the Pay Modal. Default is FLW PAY.
* Modal Description - (Optional) customize the description on the Pay Modal. Default is FLW PAY MODAL.
* Modal Logo - (Optional) customize the logo on the Pay Modal. Enter a full url (with \'http\'). Default is Rave logo.
* Success Redirect URL - (Optional) The URL the user should be redirected to after a successful payment. Enter a full url (with 'http:\\'). Default: '\'.
* Failed Redirect URL - (Optional) The URL the user should be redirected to after a failed payment. Enter a full url (with 'http:\\'). Default: '\'.
* Pay Button Text - (Optional) The text to display on the button. Default: "PAY NOW".
* Charge Currency - (Optional) The currency the user is charged. Default: "NGN".
* Charge Country - (Optional) The country the merchant is serving. Default: "NG: Nigeria".
* Form Style - (Optional) Disable form default style and use the activated theme style instead.
* Click Save Changes to save your changes.
= Styling =
You can enable default theme's style to override default form style from the Settings page. Or you can override the formclass .flw-simple-pay-now-form from your stylesheet.
= Usage =
* a. Shortcode
Insert the shortcode anywhere on your page or post that you want the form to be displayed to the user.
Basic: requires the user to enter amount and email to complete payment
[flw-pay-button]
With button text:
[flw-pay-button]Button Text[/flw-pay-button]
With attributes: email or use_current_user_email with value "yes", amount
[flw-pay-button amount="1290" email="customer@email.com" ]
or
[flw-pay-button amount="1290" use_current_user_email="yes" ]
With attributes and button text: email, amount
[flw-pay-button amount="1290" email="customer@email.com" ]Button Text[/flw-pay-button]
With currency
[flw-pay-button custom_currency="NGN,GBP,USD"]
With attributes: email or use_current_user_email with value "yes", amount and currency
[flw-pay-button amount="1290" email="customer@email.com" custom_currency= "NGN, GBP, USD" ]
or
[flw-pay-button amount="1290" use_current_user_email="yes" custom_currency= "NGN, GBP, USD" ]
With currency:
[flw-pay-button custom_currency="NGN,GBP,USD"]
With attributes: email or use_current_user_email with value "yes", amount and currency
[flw-pay-button amount="1290" email="customer@email.com" custom_currency= "NGN, GBP, USD" ]
or
[flw-pay-button amount="1290" use_current_user_email="yes" custom_currency= "NGN, GBP, USD" ]
* b. Visual Composer
The shortcode can be added via Visual Composer elements.
On Visual Composer Add Element dialog, click on "Rave Forms" and select the type of form you want to include on your page.
On the "Form Settings" dialog, fill in the form attributes and click "Save Changes".
Payment Form successfully added to the page.
= Best Practices =
1. When in doubt about a transaction, always check the Flutterwave Dashboard to confirm the status of a transaction.
2. Always ensure you keep your API keys securely and privately. Do not share with anyone
3. Ensure you change from the default secret hash on the Wordpress admin and apply same on the Flutterwave Dashboard
4. Always ensure you install the most recent version of the Flutterwave Wordpress plugin
= Debugging Errors =
We understand that you may run into some errors while integrating our plugin. You can read more about our error messages [here](https://developer.flutterwave.com/docs/integration-guides/errors).
For `authorization` and `validation` error responses, double-check your API keys and request. If you get a `server` error, kindly engage the team for support.
= Support =
For additional assistance using this library, contact the developer experience (DX) team via [email](mailto:developers@flutterwavego.com) or on [slack](https://bit.ly/34Vkzcg).
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
= Contribution guidelines =
We love to get your input. Read more about our community contribution guidelines [here](/CONTRIBUTING.md)
= License =
By contributing to the Flutterwave WooCommerce, you agree that your contributions will be licensed under its [MIT license](/LICENSE).
== Screenshots ==
1. To configure the plugin, go to Rave > Settings from the left menu.
2. On Visual Composer Add Element dialog, click on "Rave Forms" and select the type of form you want to include on your page.
3. On the "Form Settings" dialog, fill in the form attributes and click "Save Changes".
4. Payment Form successfully added to the page.
5. All the payments made through the forms to Rave can be accessed on Rave > Transactions page.
== Changelog ==
v1.0.3
* This version allows you to add additional fields to the form.
* This version allow you to set default values to fields.
* This version allows you to hid fields "By appending '-h' to the name of the field".
* This version now allow for mobile money option in UGx,TZS,GHS respectively
v1.0.2
*Recuring payment section add under "Payment Plan"
v 1.0.1
* Recurring payments now enabled.
v 1.0.0
== Upgrade Notice ==
v1.0.1 - 12-02-2018
* This version doesn't redirect after failure, it allows the customer try payment again.
* This version allows you use multiple currencies on the Wordpress payment form.
* This version now has recurring payments.