Download the PHP package sescandell/bitpay-client without Composer

On this page you can find all versions of the php package sescandell/bitpay-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of sescandell/bitpay-client

Informations about the package bitpay-client

BitPay Library for PHP

Powerful, flexible, lightweight interface to the BitPay Bitcoin Payment Gateway API.

Installing via Composer

The recommended way to install the BitPay PHP Client is through Composer.

After installing, you need to require Composer's autoloader:

The library requires PHP 5.3+ and is PSR-0 compatible.

Basic Usage

To create an invoice:

With invoice creation, orderID and currency are the only required fields. If you are sending a customer from your website to make a purchase, setting redirectURL on BitPay constructor options is required.

Response will be an object with information on your newly created invoice. Send your customer to the url to complete payment:

There are many options available when creating invoices, which are listed in the BitPay API documentation.

To get updated information on this invoice, make a get call with the ID returned:

Options

When you instantiate BitPay you can pass options as a fourth argument. You can also set this options dinamically with setOptions(). Please look carefully through these options and adjust according to your installation.

Option Default Description
verifyPost true Whether to verify POS data by hashing above api key. If set to false, you should have some way of verifying that callback data comes from bitpay.com.
notificationEmail '' Email where invoice update notifications should be sent.
notificationURL '' URL where bit-pay server should send update notifications. See API doc for more details.
redirectURL '' URL where the customer should be directed to after paying for the order.
currency 'BTC' This is the currency used for the price setting. A list of other pricing currencies supported is found at bitpay.com
physical true Indicates whether anything is to be shipped with the order (if false, the buyer will be informed that nothing is to be shipped)
fullNotifications true If set to false, then notificaitions are only sent when an invoice is confirmed (according the the transactionSpeed setting). If set to true, then a notification will be sent on every status change.
transactionSpeed 'low' Transaction speed: low/medium/high. See API docs for more details.

API Documentation

API Documentation is available on the BitPay site.

Running the Tests

In addition to a full test suite, there is Travis integration.

Found a bug?

Let us know! Send a pull request or a patch. Questions? Ask! We're here to help. We will respond to all filed issues.

Authors

All versions of bitpay-client with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.3
ext-curl Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sescandell/bitpay-client contains the following files

Loading the files please wait ....