README

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.

btcpayserver/btcpayserver-php-client

This is a self-contained PHP implementation of BTCPayServer's cryptographically secure API: https://github.com/btcpayserver/btcpayserver-doc/blob/master/docs/CustomIntegration.md

Before you start

If your application requires BitPay compatibility go to this repository instead https://github.com/btcpayserver/php-bitpay-client

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

Version 0.2.0

• 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

• Previous versions were not numbered.

Installation

Composer

Install Composer

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

Install using composer

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

Configuration

See https://github.com/btcpayserver/btcpayserver-php-client/tree/master/examples

Usage

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: https://github.com/btcpayserver/btcpayserver-php-client/blob/master/examples/tutorial/

Support

• https://github.com/btcpayserver/btcpayserver-php-client/issues