Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 2.98 KB

README.md

File metadata and controls

89 lines (58 loc) · 2.98 KB
Raw

BitPay PHP Client

GitHub license Packagist Total Downloads

Full implementation of the BitPay Payment Gateway. This library implements BitPay's Cryptographically Secure RESTful API.

Getting Started

To get up and running with our PHP library quickly, follow the guide

Support

Requirements

  • PHP version: 8.1 / 8.2 / 8.3
  • PHP extensions: json, reflection

Unit Tests

./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:

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:

./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.