PHPackages                             btcpayserver/btcpayserver-php-client - 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. [API Development](/categories/api)
4. /
5. btcpayserver/btcpayserver-php-client

AbandonedArchivedLibrary[API Development](/categories/api)

btcpayserver/btcpayserver-php-client
====================================

PHP Library to work with the new cryptographically secure BTCPayServer API

v1.0.1(4y ago)2897.2k—1.6%32[16 issues](https://github.com/btcpayserver/btcpayserver-php-client/issues)[2 PRs](https://github.com/btcpayserver/btcpayserver-php-client/pulls)2MITPHPPHP >=7.1

Since Mar 12Pushed 4y ago8 watchersCompare

[ Source](https://github.com/btcpayserver/btcpayserver-php-client)[ Packagist](https://packagist.org/packages/btcpayserver/btcpayserver-php-client)[ Docs](https://github.com/btcpayserver/btcpayserver-php-client)[ RSS](/packages/btcpayserver-btcpayserver-php-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (13)Versions (8)Used By (2)

=== Warning ===
===============

[](#-warning-)

This is the old BitPay based PHP client and should be considered deprecated (even though it currently still works). If you are building something from scratch, [use the new Greenfield API](https://github.com/btcpayserver/btcpayserver-greenfield-php).

btcpayserver/btcpayserver-php-client
====================================

[](#btcpayserverbtcpayserver-php-client)

[![GitHub license](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](https://raw.githubusercontent.com/btcpayserver/btcpayserver-php-client/master/LICENSE.md)[![Travis](https://camo.githubusercontent.com/15dda4c628b3494ab35e3f9151739b4dcdaea749e118c4e2b088f05a85cd00d7/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6274637061797365727665722f6274637061797365727665722d7068702d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/btcpayserver/btcpayserver-php-client)[![Packagist](https://camo.githubusercontent.com/8ededb1757b5cc9f7ed6029fa2bc70d43f9c6ac564418a39b9481486381caeea/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6274637061797365727665722f6274637061797365727665722d7068702d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/btcpayserver/btcpayserver-php-client)[![Code Climate](https://camo.githubusercontent.com/2d21b59d91bfa6285b3731f835f2e0da550fd4ceb36f24c6e53d761a96703e29/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636c696d6174652f6769746875622f6274637061797365727665722f6274637061797365727665722d7068702d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://codeclimate.com/github/btcpayserver/btcpayserver-php-client)[![Scrutinizer](https://camo.githubusercontent.com/5dd918729b40cd7757e00b36c0ea73bfbf8edf6a021332de543b8bf7d7b1c198/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6274637061797365727665722f6274637061797365727665722d7068702d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/btcpayserver/btcpayserver-php-client/)[![Coveralls](https://camo.githubusercontent.com/b87fabe0cda88c1a1aefa233a9c96aef010403433c0f12e8d8053bcdc8e8f532/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f6274637061797365727665722f6274637061797365727665722d7068702d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://coveralls.io/r/btcpayserver/btcpayserver-php-client)

[![Documentation Status](https://camo.githubusercontent.com/cd7425b402cb769428e46616e12d9c3f9cc7b33afcfbf3f07a0ee5653326d19f/68747470733a2f2f72656164746865646f63732e6f72672f70726f6a656374732f7068702d6274637061792d636c69656e742f62616467652f3f76657273696f6e3d6c6174657374)](https://readthedocs.org/projects/php-btcpay-client/?badge=latest)[![Total Downloads](https://camo.githubusercontent.com/97eca784c4ccb8fecc3d15ec10aeaff973e318a21e561a694dd1698703866d63/68747470733a2f2f706f7365722e707567782e6f72672f6274637061797365727665722f6274637061797365727665722d7068702d636c69656e742f646f776e6c6f6164732e737667)](https://packagist.org/packages/btcpayserver/btcpayserver-php-client)[![Latest Unstable Version](https://camo.githubusercontent.com/382b4ae8587aea0fae47f81f1ad6ab16784cec1954234959a34c189abc7491e2/68747470733a2f2f706f7365722e707567782e6f72672f6274637061797365727665722f6274637061797365727665722d7068702d636c69656e742f762f756e737461626c652e737667)](https://packagist.org/packages/btcpayserver/btcpayserver-php-client)

This is a self-contained PHP implementation of BTCPayServer's cryptographically secure API:

Before you start
================

[](#before-you-start)

If your application requires BitPay compatibility go to this repository instead

The files in "examples" are migrated from previous versions and are UNTESTED. If someone can review the example files and improve them, please help out.

Important upgrade notes
=======================

[](#important-upgrade-notes)

Version 0.2.0
-------------

[](#version-020)

- The latest changes made in BitPay's v4 API are now reflected in this API.
- If you previously had "401 unauthorized" issues with this API, these should now be fixed.
- This PHP API no longer depends on Symfony, making this framework independent. If you were using this API in combination with Symfony and require a Symfony service, you can get the old files from the `old-master` branch. We recommended you to keep the Symfony stuff separate.

Version 0.1.2
-------------

[](#version-012)

- Previous versions were not numbered.

Installation
============

[](#installation)

Composer
--------

[](#composer)

### Install Composer

[](#install-composer)

```
curl -sS https://getcomposer.org/installer | php
```

### Install using composer

[](#install-using-composer)

```
php composer.phar require btcpayserver/btcpayserver-php-client
```

Configuration
=============

[](#configuration)

See

Usage
=====

[](#usage)

Documentation
-------------

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

Support
=======

[](#support)

-

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance9

Infrequent updates — may be unmaintained

Popularity45

Moderate usage in the ecosystem

Community34

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 51.9% 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 ~193 days

Recently: every ~221 days

Total

6

Last Release

1658d ago

Major Versions

v0.2.0 → v1.0.02019-08-17

PHP version history (2 changes)v0.1.0PHP >=5.4

v0.1.2PHP >=7.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/4c5d7eced5c1e83ea0d795059900fae188d6f5c09f91f2774ab6034e5d945da2?d=identicon)[woutersamaey](/maintainers/woutersamaey)

![](https://www.gravatar.com/avatar/02dde712d241ac6dd799da9515ecfb336da7be6e36d2206077fede8ea65002d4?d=identicon)[psyb0t](/maintainers/psyb0t)

---

Top Contributors

[![ionux](https://avatars.githubusercontent.com/u/6451654?v=4)](https://github.com/ionux "ionux (215 commits)")[![JoshuaEstes](https://avatars.githubusercontent.com/u/447419?v=4)](https://github.com/JoshuaEstes "JoshuaEstes (71 commits)")[![NicolasDorier](https://avatars.githubusercontent.com/u/3020646?v=4)](https://github.com/NicolasDorier "NicolasDorier (19 commits)")[![woutersamaey](https://avatars.githubusercontent.com/u/71019?v=4)](https://github.com/woutersamaey "woutersamaey (17 commits)")[![kakaska](https://avatars.githubusercontent.com/u/5438767?v=4)](https://github.com/kakaska "kakaska (16 commits)")[![psyb0t](https://avatars.githubusercontent.com/u/12934156?v=4)](https://github.com/psyb0t "psyb0t (13 commits)")[![sashmaaan](https://avatars.githubusercontent.com/u/8039445?v=4)](https://github.com/sashmaaan "sashmaaan (7 commits)")[![kleetus](https://avatars.githubusercontent.com/u/12446?v=4)](https://github.com/kleetus "kleetus (7 commits)")[![Kukks](https://avatars.githubusercontent.com/u/1818366?v=4)](https://github.com/Kukks "Kukks (5 commits)")[![SelimSalihovic](https://avatars.githubusercontent.com/u/3939551?v=4)](https://github.com/SelimSalihovic "SelimSalihovic (4 commits)")[![ndeet](https://avatars.githubusercontent.com/u/1136761?v=4)](https://github.com/ndeet "ndeet (4 commits)")[![mikegogulski](https://avatars.githubusercontent.com/u/118625?v=4)](https://github.com/mikegogulski "mikegogulski (4 commits)")[![gabegattis](https://avatars.githubusercontent.com/u/4419243?v=4)](https://github.com/gabegattis "gabegattis (3 commits)")[![arubacao](https://avatars.githubusercontent.com/u/7462542?v=4)](https://github.com/arubacao "arubacao (3 commits)")[![reablaz](https://avatars.githubusercontent.com/u/3844596?v=4)](https://github.com/reablaz "reablaz (3 commits)")[![raul782](https://avatars.githubusercontent.com/u/181557?v=4)](https://github.com/raul782 "raul782 (3 commits)")[![benrcole](https://avatars.githubusercontent.com/u/2944207?v=4)](https://github.com/benrcole "benrcole (3 commits)")[![FallDi](https://avatars.githubusercontent.com/u/4299295?v=4)](https://github.com/FallDi "FallDi (2 commits)")[![jonhkr](https://avatars.githubusercontent.com/u/767866?v=4)](https://github.com/jonhkr "jonhkr (2 commits)")[![gasteve](https://avatars.githubusercontent.com/u/639093?v=4)](https://github.com/gasteve "gasteve (2 commits)")

---

Tags

bitcoinbtcpayserver

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/btcpayserver-btcpayserver-php-client/health.svg)

```
[![Health](https://phpackages.com/badges/btcpayserver-btcpayserver-php-client/health.svg)](https://phpackages.com/packages/btcpayserver-btcpayserver-php-client)
```

###  Alternatives

[coinbase/coinbase-commerce

Coinbase Commerce API library

148275.7k2](/packages/coinbase-coinbase-commerce)[coinpaymentsnet/coinpayments-php

A PHP wrapper for the CoinPayments.net v1 API.

55126.2k](/packages/coinpaymentsnet-coinpayments-php)[mocking-magician/coinbase-pro-sdk

Library for coinbase pro API calls

223.2k](/packages/mocking-magician-coinbase-pro-sdk)

PHPackages © 2026

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