PHPackages                             bitpay/sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. bitpay/sdk

ActiveLibrary[Payment Processing](/categories/payments)

bitpay/sdk
==========

Complete version of the PHP library for the new cryptographically secure BitPay API

10.1.4(5d ago)42361.9k↓45.5%424MITPHPPHP ^8.2 || ^8.3 || ^8.4 || ^8.5CI passing

Since Oct 8Pushed 1w ago6 watchersCompare

[ Source](https://github.com/bitpay/php-bitpay-client-v2)[ Packagist](https://packagist.org/packages/bitpay/sdk)[ Docs](https://github.com/bitpay/php-bitpay-client-v2)[ RSS](/packages/bitpay-sdk/feed)WikiDiscussions 10.1.x Synced 3d ago

READMEChangelog (10)Dependencies (28)Versions (74)Used By (4)

[![](https://camo.githubusercontent.com/11db3ae0c8970a72369f08e95975f72e1f0e88efa4da3bc15aa5b68fa426a556/68747470733a2f2f6269747061792e636f6d2f5f6e7578742f696d672f6269747061792d6c6f676f2d626c75652e316330343934622e737667)](https://camo.githubusercontent.com/11db3ae0c8970a72369f08e95975f72e1f0e88efa4da3bc15aa5b68fa426a556/68747470733a2f2f6269747061792e636f6d2f5f6e7578742f696d672f6269747061792d6c6f676f2d626c75652e316330343934622e737667)

BitPay PHP Client
=================

[](#bitpay-php-client)

[![GitHub license](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](https://raw.githubusercontent.com/bitpay/php-bitpay-client-v2/master/LICENSE)[![Packagist](https://camo.githubusercontent.com/2f35005743af52a843fa14be1e0b84cce3527b001e75ed706602cd4619e80fcc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6269747061792f73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/bitpay/sdk)[![Total Downloads](https://camo.githubusercontent.com/7629d437c28eef143325949cefaea0b17e91d38c0d75844429235f324b5ab81f/68747470733a2f2f706f7365722e707567782e6f72672f6269747061792f73646b2f646f776e6c6f6164732e737667)](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
---------------

[](#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
-------

[](#support)

-
-

### Requirements

[](#requirements)

- PHP version: 8.2 / 8.3 / 8.4 / 8.5
- PHP extensions: json, reflection

Unit Tests
----------

[](#unit-tests)

```
./vendor/bin/phpunit --testsuite "Unit"
```

Functional Tests
----------------

[](#functional-tests)

To run functional tests you will need to perform the following steps.

### Generate Configuration

[](#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

[](#create-recipient)

To submit requests you should:

1. Create a recipient in
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-functional-tests)

Run the following command to execute the functional tests:

```
./vendor/bin/phpunit --testsuite "Functional"
```

Contribute
----------

[](#contribute)

To contribute to this project, please fork and submit a pull request.

License
-------

[](#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.

###  Health Score

72

—

ExcellentBetter than 100% of packages

Maintenance99

Actively maintained with recent releases

Popularity50

Moderate usage in the ecosystem

Community32

Small or concentrated contributor base

Maturity90

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 60.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~38 days

Recently: every ~30 days

Total

65

Last Release

3d ago

Major Versions

7.3.0 → 8.0.0-beta12023-04-02

7.4.0 → 8.0.02023-06-26

7.5.x-dev → 8.0.x-dev2024-04-04

8.0.x-dev → 9.0.02024-04-12

9.3.2 → 10.0.02026-01-08

PHP version history (10 changes)v3.0.1910PHP ^7.3

v3.2.1911PHP ^7.1

v5.1.2106PHP ^7.1 || ^8.0

7.0.0PHP ^7.4 || ^8.0 || ^8.1

8.0.0-beta1PHP ^8.0 || ^8.1 || ^8.2

7.5.0PHP ^7.4 || ^8.0 || ^8.1 || ^8.2 || ^8.3

9.0.0PHP ^8.1 || ^8.2 || ^8.3

9.2.0PHP ^8.1 || ^8.2 || ^8.3 || ^8.4

10.0.0PHP ^8.2 || ^8.3 || ^8.4

10.1.0PHP ^8.2 || ^8.3 || ^8.4 || ^8.5

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/2554930?v=4)[BitPay](/maintainers/bitpay)[@bitpay](https://github.com/bitpay)

---

Top Contributors

[![bobbrodie](https://avatars.githubusercontent.com/u/123703?v=4)](https://github.com/bobbrodie "bobbrodie (360 commits)")[![mwarzybok-sumoheavy](https://avatars.githubusercontent.com/u/113988788?v=4)](https://github.com/mwarzybok-sumoheavy "mwarzybok-sumoheavy (82 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (34 commits)")[![virtua-wkogut](https://avatars.githubusercontent.com/u/55840958?v=4)](https://github.com/virtua-wkogut "virtua-wkogut (28 commits)")[![swlodarski-sumoheavy](https://avatars.githubusercontent.com/u/28725696?v=4)](https://github.com/swlodarski-sumoheavy "swlodarski-sumoheavy (25 commits)")[![SUMO-Kwiatkowski](https://avatars.githubusercontent.com/u/110228238?v=4)](https://github.com/SUMO-Kwiatkowski "SUMO-Kwiatkowski (18 commits)")[![alexstewartja](https://avatars.githubusercontent.com/u/6935309?v=4)](https://github.com/alexstewartja "alexstewartja (8 commits)")[![m-kwiatkowski](https://avatars.githubusercontent.com/u/131860085?v=4)](https://github.com/m-kwiatkowski "m-kwiatkowski (8 commits)")[![aharoitx](https://avatars.githubusercontent.com/u/236879968?v=4)](https://github.com/aharoitx "aharoitx (6 commits)")[![p-maguire](https://avatars.githubusercontent.com/u/33061385?v=4)](https://github.com/p-maguire "p-maguire (5 commits)")[![nsoni3](https://avatars.githubusercontent.com/u/80480978?v=4)](https://github.com/nsoni3 "nsoni3 (4 commits)")[![ppatidar2021](https://avatars.githubusercontent.com/u/89529106?v=4)](https://github.com/ppatidar2021 "ppatidar2021 (4 commits)")[![peter279k](https://avatars.githubusercontent.com/u/9021747?v=4)](https://github.com/peter279k "peter279k (2 commits)")[![shaankat](https://avatars.githubusercontent.com/u/52571658?v=4)](https://github.com/shaankat "shaankat (2 commits)")[![gmponos](https://avatars.githubusercontent.com/u/5675248?v=4)](https://github.com/gmponos "gmponos (2 commits)")[![danrcastro](https://avatars.githubusercontent.com/u/6893657?v=4)](https://github.com/danrcastro "danrcastro (1 commits)")[![porthorian](https://avatars.githubusercontent.com/u/34264214?v=4)](https://github.com/porthorian "porthorian (1 commits)")[![rwellens](https://avatars.githubusercontent.com/u/166146?v=4)](https://github.com/rwellens "rwellens (1 commits)")[![darksniper87](https://avatars.githubusercontent.com/u/6402985?v=4)](https://github.com/darksniper87 "darksniper87 (1 commits)")[![nicandr](https://avatars.githubusercontent.com/u/16088589?v=4)](https://github.com/nicandr "nicandr (1 commits)")

---

Tags

paymentgatewaybitcoincashbitpay

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/bitpay-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/bitpay-sdk/health.svg)](https://phpackages.com/packages/bitpay-sdk)
```

###  Alternatives

[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

21866.0M1.7k](/packages/drupal-core)[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6942.5M421](/packages/drupal-core-recommended)[craftcms/cms

Craft CMS

3.6k3.6M3.1k](/packages/craftcms-cms)[tempest/framework

The PHP framework that gets out of your way.

2.2k34.4k15](/packages/tempest-framework)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M574](/packages/shopware-core)[typo3/cms

TYPO3 CMS is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL.

1.2k1.9M122](/packages/typo3-cms)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)