dimsav / bitpay-php-client
PHP Library to work with the new cryptographically secure BitPay API
Requires
- php: >=5.4
- ext-bcmath: *
- ext-curl: *
- ext-json: *
- ext-openssl: *
- symfony/config: ^2.3 || ^3.0 || ^4.0
- symfony/dependency-injection: ^2.3 || ^3.0 || ^4.0 || ^4.2
Requires (Dev)
- behat/behat: 2.5.*@stable
- behat/mink: 1.6.1
- behat/mink-extension: 1.3.*
- behat/mink-goutte-driver: 1.*
- behat/mink-selenium2-driver: 1.2.0
- fabpot/goutte: ~1.0.4
- fzaninotto/faker: ~1.4.0
- mikey179/vfsstream: ~1.4.0
- phpmd/phpmd: ~2.1.3
- phpunit/phpunit: ~4.8.35
- satooshi/php-coveralls: ~0.6.1
- squizlabs/php_codesniffer: ~1.5.5
- symfony/phpunit-bridge: ^4.0
Suggests
- ext-gmp: Quickest PHP math extension for doing computationally-expensive work.
README
This is a self-contained PHP implementation of BitPay's new cryptographically secure API: https://bitpay.com/api
Installation
Composer
Install Composer
curl -sS https://getcomposer.org/installer | php
Install via composer by hand
Add to your composer.json file by hand.
{ ... "require": { ... "bitpay/php-client": "~2.2" } ... }
Once you have added this, just run:
php composer.phar update bitpay/php-client
Install using composer
php composer.phar require bitpay/php-client:~2.2
Configuration
Usage
Autoloader
To use the library's autoloader (which doesn't include composer dependencies) instead of composer's autoloader, use the following code:
<?php $autoloader = __DIR__ . '/relative/path/to/Bitpay/Autoloader.php'; if (true === file_exists($autoloader) && true === is_readable($autoloader)) { require_once $autoloader; \Bitpay\Autoloader::register(); } else { throw new Exception('BitPay Library could not be loaded'); }
Documentation
Please see the docs
directory for information on how to use this library
and the examples
directory for examples on using this library. You should
be able to run all the examples by running php examples/File.php
.
The examples/tutorial
directory provides four scripts that guide you with creating a BitPay invoice:
https://github.com/bitpay/php-bitpay-client/blob/master/examples/tutorial/
Support
When you receive blank IPN responses, please check https://support.bitpay.com/hc/en-us/articles/115003025706-Why-am-I-getting-a-blank-IPN-post-response-from-BitPay-when-using-PHP-
License
The MIT License (MIT)
Copyright (c) 2018 BitPay, Inc.
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.