https://github.com/bitpay/php-bitpay-client-v2
PHP implementation for the BitPay Cryptographically Secure RESTful API
https://github.com/bitpay/php-bitpay-client-v2
Last synced: 4 months ago
JSON representation
PHP implementation for the BitPay Cryptographically Secure RESTful API
- Host: GitHub
- URL: https://github.com/bitpay/php-bitpay-client-v2
- Owner: bitpay
- License: mit
- Created: 2019-09-13T10:00:41.000Z (over 6 years ago)
- Default Branch: 9.2.x
- Last Pushed: 2025-05-05T00:05:57.000Z (about 1 year ago)
- Last Synced: 2025-05-14T03:24:03.320Z (about 1 year ago)
- Language: PHP
- Size: 3.22 MB
- Stars: 44
- Watchers: 7
- Forks: 42
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BitPay PHP Client
[](https://raw.githubusercontent.com/bitpay/php-bitpay-client-v2/master/LICENSE)
[](https://packagist.org/packages/bitpay/sdk)
[](https://packagist.org/packages/bitpay/sdk)
Full implementation of the BitPay Payment Gateway. This library implements BitPay's [Cryptographically Secure RESTful API](https://developer.bitpay.com/reference/concepts).
## Getting Started
To get up and running with our PHP library quickly, follow [the guide](https://developer.bitpay.com/reference/php-full-sdk-getting-started)
## Support
* https://github.com/bitpay/php-bitpay-client-v2/issues
* https://support.bitpay.com
### Requirements
- PHP version: 8.1 / 8.2 / 8.3
- PHP extensions: json, reflection
## Unit Tests
```php
./vendor/bin/phpunit --testsuite "Unit"
```
## Functional Tests
To run functional tests you will need to perform the following steps.
### Generate Configuration
Run the following command to generate `BitPay.config.yml`:
```bash
composer setup
```
Copy `BitPay.config.yml` to the `test/functional/BitPaySDK` directory.
Copy `PrivateKeyName.key` to the `setup` directory.
### Create Recipient
To submit requests you should:
1. Create a recipient in https://test.bitpay.com/dashboard/payouts/recipients
2. Accept the invite in the recipient's email inbox
3. Create a file at `test/functional/BitPaySDK/email.txt` containing the email
address of the recipient you created in step 1.
### Run the Functional Tests
Run the following command to execute the functional tests:
```php
./vendor/bin/phpunit --testsuite "Functional"
```
## Contribute
To contribute to this project, please fork and submit a pull request.
## License
MIT License
Copyright (c) 2019 BitPay
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.