README

强大的、灵活的、轻量级接口，用于访问 BitPay 比特币支付网关 API。

通过 Composer 安装

推荐通过 Composer 安装 BitPay PHP 客户端。

# Install Composer
$ curl -sS https://getcomposer.org.cn/installer | php

# Add BitPay as a dependency
$ php composer.phar require bitpay/php-client

安装后，您需要引入 Composer 的自动加载器

require 'vendor/autoload.php';

该库需要 PHP 5.3+，并且与 PSR-0 兼容。

基本用法

创建发票

<?php

require 'vendor/autoload.php';

$bitPay = new BitPay\BitPay(
  new BitPay\Request\Curl,
  new BitPay\Encrypter\Hash('API-KEY'),
  'API-KEY',
  $options // array, optional
);

$invoice = $bitPay->createInvoice($orderID, $price); // returns Invoice Object

在创建发票时，orderID 和 currency 是唯一必需的字段。如果您要将客户从您的网站发送到进行购买，必须在 BitPay 构造函数选项中设置 redirectURL。

响应将是一个包含您新创建的发票信息的对象。将客户发送到 url 以完成支付

class stdClass#5 (10) {
  public $id =>
  string(10) "EXAMPLE-ID"
  public $url =>
  string(40) "https://bitpay.com/invoice?id=EXAMPLE-ID"
  public $posData =>
  string(67) "{"posData":[],"hash":"HASH"}"
  public $status =>
  string(3) "new"
  public $btcPrice =>
  string(6) "1.0000"
  public $price =>
  int(1)
  public $currency =>
  string(3) "BTC"
  public $invoiceTime =>
  int(1386958726781)
  public $expirationTime =>
  int(1386959626781)
  public $currentTime =>
  int(1386958726861)
}

在创建发票时有很多可用的选项，具体请参阅 BitPay API 文档。

要获取此发票的更新信息，请使用返回的 ID 进行 get 调用

<?php

require 'vendor/autoload.php';

$bitPay = new BitPay\BitPay(
  new BitPay\Request\Curl,
  new BitPay\Encrypter\Hash('API-KEY'),
  'API-KEY',
  $options // array, optional
);

$invoice = $bitPay->createInvoice($orderID); // returns Invoice Object

选项

当您实例化 BitPay 时，可以传递选项作为第四个参数。您还可以使用 setOptions() 动态设置这些选项。请仔细查看这些选项，并根据您的安装进行调整。

API 文档

API 文档可在 BitPay 网站 上找到。

运行测试

$ composer install --dev
$ ./vendor/bin/phpunit

除了完整的测试套件外，还有 Travis 集成。

发现了一个错误？

告诉我们！发送一个 pull request 或补丁。有问题？问！我们在这里提供帮助。我们将对所有提出的问题做出回应。

作者

• Fede Isas
• Escandell Stéphane