| 1 |
©2011,2012,2013,2014 BITPAY, INC. |
| 2 |
|
| 3 |
Permission is hereby granted to any person obtaining a copy of this software |
| 4 |
and associated documentation for use and/or modification in association with |
| 5 |
the bitpay.com service. |
| 6 |
|
| 7 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 8 |
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 9 |
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 10 |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 11 |
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 12 |
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 13 |
THE SOFTWARE. |
| 14 |
|
| 15 |
|
| 16 |
Bitcoin PHP payment library using the bitpay.com service. |
| 17 |
|
| 18 |
|
| 19 |
Installation |
| 20 |
------------ |
| 21 |
Copy these files into your custom shopping cart implementation directory. |
| 22 |
|
| 23 |
|
| 24 |
Configuration |
| 25 |
------------- |
| 26 |
NOTE: PHP 5.x, curl, and SSL is required for use of this BitPay PHP code library. |
| 27 |
|
| 28 |
1. Create an API key at bitpay.com by clicking My Account > API Access Keys > Add New API Key. |
| 29 |
2. In the bp_options.php file, configure the options specific to your implementation. |
| 30 |
|
| 31 |
|
| 32 |
Usage |
| 33 |
----- |
| 34 |
1. In your shopping cart code, call bpCreateInvoice() with the appropriate orderID, price, |
| 35 |
posData and options. |
| 36 |
2. The library will attempt to POST the new invoice information via curl to the BitPay |
| 37 |
network. If successful, you will receive an invoice in the return response. Any errors |
| 38 |
in this process will return an array with a single element: 'error' and the exception msg. |
| 39 |
3. You may use the bpLog function manually to log any information you would like to track or |
| 40 |
automatically by setting the useLogging option to true in the bp_options file. The log file |
| 41 |
could potentially get very large, depending on usage, so monitor closely or only use |
| 42 |
during debugging. |
| 43 |
|
| 44 |
|
| 45 |
Change Log |
| 46 |
---------- |
| 47 |
Version 1 |
| 48 |
- Initial version |
| 49 |
|
| 50 |
Version 1.1, [email protected] |
| 51 |
- Improved error handling, documentation |
| 52 |
- Added license information |
| 53 |
- Added automatic logging functionality (off by default) |
| 54 |
|
