Skip to content
PHP implementation for the BTCPayServer cryptographically secure RESTful API
Branch: master
Clone or download
psyb0t Merge pull request #9 from elvismdev/patch-1
Fix file name of class BTCPayServerException
Latest commit 86ff672 Jul 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build replace user psyb0t with btcpayserver org + more bitpay rm Mar 12, 2019
docs replace user psyb0t with btcpayserver org + more bitpay rm Mar 12, 2019
examples
src/BTCPayServer Fix file name of class BTCPayServerException Jul 5, 2019
.coveralls.yml
.editorconfig This introduces new steps to check the format of price Jun 17, 2015
.gitignore Added files for integration testing Nov 3, 2014
.travis.yml Update .travis.yml to also test against PHP 7.2 Dec 1, 2017
CHANGELOG.md Replace bitpay strings with btcpayserver and remove a couple of unrel… Mar 6, 2019
LICENSE.md Replace bitpay strings with btcpayserver and remove a couple of unrel… Mar 6, 2019
Makefile Mink/Behat testing begun Dec 11, 2014
README.md Inform about BitPay compatibility repo Mar 13, 2019
VERSION Replace bitpay strings with btcpayserver and remove a couple of unrel… Mar 6, 2019
behat.yml Tests now can be applied to any server Jan 2, 2015
build.xml Replace bitpay strings with btcpayserver and remove a couple of unrel… Mar 6, 2019
composer.json replace user psyb0t with btcpayserver org + more bitpay rm Mar 12, 2019
integration_tests.sh replace user psyb0t with btcpayserver org + more bitpay rm Mar 12, 2019
package.json replace user psyb0t with btcpayserver org + more bitpay rm Mar 12, 2019

README.md

btcpayserver/btcpayserver-php-client

GitHub license Travis Packagist Code Climate Scrutinizer Coveralls

Documentation Status Total Downloads Latest Unstable Version

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

Before you start

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

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

Autoloader

To use the library's autoloader (which doesn't include composer dependencies) instead of composer's autoloader, use the following code:

<?php
$autoloader = __DIR__ . '/relative/path/to/src/BTCPayServer/Autoloader.php';
if (true === file_exists($autoloader) &&
    true === is_readable($autoloader))
{
    require_once $autoloader;
    \BTCPayServer\Autoloader::register();
} else {
    throw new Exception('BTCPayServer Library could not be loaded');
}

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

License

The MIT License (MIT)

Copyright (c) 2017 BTCPayServer, Inc.

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.

You can’t perform that action at this time.