-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathreadme.txt
More file actions
429 lines (309 loc) · 9.58 KB
/
readme.txt
File metadata and controls
429 lines (309 loc) · 9.58 KB
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
=== CryptAPI Payment Gateway for WooCommerce ===
Contributors: cryptapi
Tags: crypto payments, woocommerce, payment gateway, crypto, payment, pay with crypto, payment request, bitcoin, bnb, usdt, ethereum, litecoin, bitcoin cash, shib, doge, solana
Requires at least: 5.8
Tested up to: 6.9
Stable tag: 5.1.5
Requires PHP: 7.2
WC requires at least: 5.8
WC tested up to: 10.4.3
License: MIT
Accept cryptocurrency payments on your WooCommerce website
== Description ==
Accept payments in Bitcoin, Ethereum, Bitcoin Cash, Litecoin, BNB, USDT, SHIB, DOGE and many more directly to your crypto wallet, without any sign-ups or lengthy processes.
All you need is to provide your crypto address.
= Allow users to pay with crypto directly on your store =
The CryptAPI plugin extends WooCommerce, allowing you to get paid in crypto directly on your store, with a simple setup and no sign-ups required.
= Accepted cryptocurrencies & tokens include: =
* (BTC) Bitcoin
* (ETH) Ethereum
* (BCH) Bitcoin Cash
* (LTC) Litecoin
* (TRX) Tron
* (BNB) Binance Coin
* (USDT) USDT
* (SHIB) Shiba Inu
* (DOGE) Dogecoin
* (POL) Polygon
* (SOL) Solana
among many others, for a full list of the supported cryptocurrencies and tokens, check [this page](https://cryptapi.io/cryptocurrencies/).
= Auto-value conversion =
CryptAPI will attempt to automatically convert the value you set on your store to the cryptocurrency your customer chose.
Exchange rates are fetched every 5 minutes from CoinGecko.
Supported currencies for automatic exchange rates are:
* (USD) United States Dollar
* (EUR) Euro
* (GBP) Great Britain Pound
* (CAD) Canadian Dollar
* (JPY) Japanese Yen
* (AED) UAE Dollar
* (MYR) Malaysian Ringgit
* (IDR) Indonesian Rupiah
* (THB) Thai Baht
* (CHF) Swiss Franc
* (COP) Colombian Peso
* (SGD) Singapore Dollar
* (RUB) Russian Ruble
* (ZAR) South African Rand
* (TRY) Turkish Lira
* (LKR) Sri Lankan Rupee
* (XAF) CFA Franc
* (RON) Romanian Leu
* (BGN) Bulgarian Lev
* (HUF) Hungarian Forint
* (CZK) Czech Koruna
* (PHP) Philippine Peso
* (PLN) Poland Zloti
* (UGX) Uganda Shillings
* (MXN) Mexican Peso
* (INR) Indian Rupee
* (HKD) Hong Kong Dollar
* (CNY) Chinese Yuan
* (BRL) Brazilian Real
* (DKK) Danish Krone
If your WooCommerce's currency is none of the above, the exchange rates will default to USD.
If you're using WooCommerce in a different currency not listed here and need support, please [contact us](https://cryptapi.io) via our live chat.
**Note:** CryptAPI will not exchange your crypto for FIAT or other crypto, just convert the value
= Why choose CryptAPI? =
CryptAPI has no setup fees, no monthly fees, no hidden costs, and you don't even need to sign-up!
Simply set your crypto addresses and you're ready to go. As soon as your customers pay we forward your earnings directly to your own wallet.
CryptAPI has a low 1% fee on the transactions processed. No hidden costs.
For more info on our fees [click here](https://cryptapi.io/fees/)
== Installation ==
= Using The WordPress Dashboard =
1. Navigate to the 'Add New' in the plugins dashboard
2. Search for 'CryptAPI Payment Gateway for WooCommerce'
3. Click 'Install Now'
4. Activate the plugin on the Plugin dashboard
= Uploading in WordPress Dashboard =
1. Navigate to the 'Add New' in the plugins dashboard
2. Navigate to the 'Upload' area
3. Select `woocommerce-cryptapi.zip` from your computer
4. Click 'Install Now'
5. Activate the plugin in the Plugin dashboard
= Using FTP =
1. Download `woocommerce-cryptapi.zip`
2. Extract the `woocommerce-cryptapi` directory to your computer
3. Upload the `woocommerce-cryptapi` directory to the `/wp-content/plugins/` directory
4. Activate the plugin in the Plugin dashboard
= Updating =
Automatic updates should work like a charm; as always though, ensure you backup your site just in case.
== Configuration ==
1. Go to WooCommerce settings
2. Select the "Payments" tab
3. Activate the payment method (if inactive)
4. Set the name you wish to show your users on Checkout (for example: "Cryptocurrency")
5. Fill the payment method's description (for example: "Pay with cryptocurrency")
6. Select which cryptocurrencies you wish to accept (control + click to select many)
7. Input your addresses to the cryptocurrencies you selected. This is where your funds will be sent to, so make sure the addresses are correct.
8. Click "Save Changes"
9. All done!
== Frequently Asked Questions ==
= Do I need an API key? =
No. You just need to insert your crypto address of the cryptocurrencies you wish to accept. Whenever a customer pays, the money will be automatically and instantly forwarded to your address.
= How long do payments take before they're confirmed? =
This depends on the cryptocurrency you're using. Bitcoin usually takes up to 11 minutes, Ethereum usually takes less than a minute.
= Is there a minimum for a payment? =
Yes, the minimums change according to the chosen cryptocurrency and can be checked [here](https://cryptapi.io/fees/).
If the WooCommerce order total is below the chosen cryptocurrency's minimum, an error is raised to the user.
= Where can I find more documentation on your service? =
You can find more documentation about our service on our [get started](https://cryptapi.io/get-started) page, our [technical documentation](https://docs.cryptapi.io/) page or our [eCommerce](https://cryptapi.io/ecommerce/) page.
If there's anything else you need that is not covered on those pages, please get in touch with us, we're here to help you!
= Where can I get support? =
The easiest and fastest way is via our live chat on our [website](https://cryptapi.io), via our [contact form](https://cryptapi.io/contacts/), via [discord](https://discord.gg/pQaJ32SGrR) or via [telegram](https://t.me/cryptapi_support).
== Screenshots ==
1. The settings panel used to configure the gateway
2. Set your crypto addresses (part 1)
3. Set your crypto addresses (part 2)
4. Example of payment using Litecoins
5. The QR code can be set to provide only the address or the address with the amount: the user can choose with one click
6. Once the payment is received, the system will wait for network confirmations
7. The payment is confirmed!
== Changelog ==
= 1.0 =
* Initial release.
= 2.0 =
* New coins
* Updated codebase
* New API URL
= 3.0 =
* UI Improvements
* Minor Bug Fixes
= 3.0.2 =
* New setting to show QR Code by default
* UI Improvements
* Minor Bug Fixes
= 3.1 =
* Add support for WooCommerce Subscriptions plugin
* Add new feature to refresh values based on store owner preferences
* Add new feature to cancel orders if they take more than selected time to pay
= 3.2 =
* UI Improvements
* Minor Bug Fixes
= 3.2.1 =
* Add translations for multiple languages
= 4.0 =
* New settings and color schemes to fit dark mode
* New settings to add CryptAPI's services fees to the checkout
* New settings to add blockchain fees to the checkout
* Upgrade the settings
* UI Improvements
* Minor fixes
= 4.0.1 =
* Minor fixes
= 4.0.2 =
* Minor fixes
= 4.0.3 =
* Minor fixes
= 4.0.4 =
* Minor fixes
= 4.0.5 =
* UI Improvements
= 4.0.6 =
* Disable QR Code with value in certain currencies due to some wallets not supporting it
= 4.0.7 =
* Minor fixes
= 4.1 =
* Added a history of transactions to the order payment page
* Better handling of partial payments
* Minor fixes
* UI Improvements
= 4.2 =
* Improved algorithm
* Minor fixes
* UI Improvements
= 4.2.1 =
* Minor fixes
= 4.2.2 =
* Minor fixes
= 4.2.3 =
* Minor fixes
= 4.2.4 =
* Minor fixes
= 4.3 =
* Improve calculations
* Minor fixes
= 4.3.1 =
* Minor fixes
= 4.3.2 =
* Minor fixes
= 4.3.3 =
* Minor fixes
= 4.3.4 =
* Feature to enable marking virtual products order as completed instead of processing
* Minor fixes
= 4.4 =
* Support CryptAPI Pro
* Minor fixes
= 4.4.1 =
* Minor fixes
= 4.4.2 =
* Minor fixes
= 4.4.3 =
* Minor fixes
= 4.5.0 =
* Minor fixes
* Improved algorithm
* Added cryptocurrencies logos to the checkout
= 4.5.1 =
* Minor fixes
= 4.5.2 =
* Minor fixes
= 4.6.0 =
* New BlockBee API Url
* Minor fixes
= 4.6.1 =
* Minor fixes
= 4.6.2 =
* New mechanisms to detect callbacks even if they fail
* Minor fixes
* Added new languages
= 4.6.3 =
* Minor fixes
= 4.6.4 =
* Minor fixes
= 4.6.5 =
* Added option to check for failed callbacks
* Minor fixes
= 4.6.6 =
* Minor fixes
= 4.6.7 =
* Minor fixes
= 4.6.8 =
* Minor fixes
= 4.6.9 =
* Minor fixes
= 4.7.0 =
* Minor fixes
* Improvements on the callback processing algorithm
= 4.7.1 =
* Minor fixes
= 4.7.2 =
* Minor fixes
= 4.7.3 =
* Minor fixes
= 4.7.4 =
* Minor fixes
= 4.7.5 =
* Minor fixes
= 4.7.6 =
* Performance improvements
* Minor fixes
= 4.7.7 =
* Minor fixes
= 4.7.8 =
* Minor fixes
= 4.7.9 =
* Support for WooCommerce HPOS.
* Minor fixes
= 4.7.10 =
* Add new choices for order cancellation.
= 4.7.11 =
* Minor fixes and improvements
= 4.7.12 =
* Minor fixes and improvements
= 4.8.0 =
* Support for new languages: German, French, Ukrainian, Russian and Chinese.
= 4.8.1 =
* Minor fixes and improvements
= 4.8.2 =
* Minor fixes and improvements
= 4.8.3 =
* Minor improvements
= 4.8.4 =
* Minor improvements
= 4.8.5 =
* Minor improvements
= 4.8.6 =
* Minor improvements
= 4.8.7 =
* Minor fixes
* Minor improvements
= 4.8.8 =
* Minor fixes
* Minor improvements
= 5.0.0 =
* Now supports WordPress Blocks.
* Bug fixes.
= 5.0.1 =
* Bug fixes.
= 5.0.2 =
* Bug fixes.
= 5.1.0 =
* Callback improvements
* Minor bugfixes
= 5.1.1 =
* Minor bugfixes
= 5.1.2 =
* Minor bugfixes
= 5.1.3 =
* Minor bugfixes
= 5.1.4 =
* Minor bugfixes
* Add a refresh coins option
= 5.1.5 =
* Added payment tolerance option to handle minor payment discrepancies
* Minor bugfixes
== Upgrade Notice ==
= 4.3 =
Please be sure to enable the PHP extension BCMath before upgrading to this version.