The Paybetr PHP library was created to serve as an example implementation of the Paybetr API. This library is currently in beta testing and may not be suitable for production environments.

Installation

Dependencies

The Paybetr PHP library utilizes HTTP client extraction through HTTPlug and will therefor require an implementation of the HTTPlug interfaces to make HTTP requests to the API. HTTPlug provides some thorough documentation on getting your environment set up to make HTTPlug requests. 

TL;DR

First, install a suitable HTTPlug library:

composer require php-http/curl-client guzzlehttp/psr7 php-http/message

Second, install the Paybetr PHP library:

composer require paybetr/paybetr-php

Usage

The Client Object

The Client object handles the majority of the API requests.

Instantiating the Client object

The client object can be instantiated directly or through the static factory constructor. You can pass in specific Http\Client\HttpClient and Http\Message\MessageFactory objects or allow the class to auto discover these objects. The static constructor takes the api token as the first argumen with the HttpClient and MessageFactory objects as optional 2nd and 3rd arguments.

$client = new Paybetr\PaybetrPHP\Client();
$client->setApiToken($apiToken);
// or
$client = Paybetr\PaybetrPHP\Client::factory($apiToken);

Client Object Methods

The following are the methods available in the client object:

Resource Objects

Each API resource such as addresses or transactions is represented by a resource object that implements the Paybetr\PaybetrPHP\Interfaces\ResourceInterface contract. The Paybetr Client object has a method for each resource that activates the proper resource object for the query.

Resource Object Methods

The Collection Object

In the instance that multiple resources are returned from a query, a collection object is returned. The collection object has methods for navigating the paging of results returned by the api. The Collection object stores each resource object in a data array.

Collection Object Methods

Examples

Instantiating the Client class

$apiToken = 'aaaabbbbccccdddd';
$client = Paybetr\PaybetrPHP\Client::factory($apiToken);

Retrieve all addresses

$addressCollection = $client->address()->get();

Retrieve all BTC addresses

$addressCollection = $client->address()->get(['symbol' => 'BTC']);

Retrieve a specific address

$address = 'aaaabbbbccccdddd';
$addressResource = $client->address()->find($address);

Create a new address

$addressResource = $client->address()->create(['symbol' => 'BTC']);

Retrieve all addresses sorted by created_at descending

$addressCollection = $client->address()->sort('-created_at')->get();

Retrieve balances for all currencies

$balanceCollection = $client->balance()->get();

Retrieve balance for a specific currency

$balanceResource = $client->balance()->find('BTC');

Retrieve a list of all currencies

$currencyCollection = $client->currency()->get();

Retrieve a specific currency

$currencyResource = $client->currency()->find('BTC');

Retrieve all exchanges

$exchangeCollection = $client->exchange()->get();

Retrieve a specific exchange

$exchangeId = '111122223333';
$exchangeResource = $client->exchange()->find($exchangeId);

Retrieve all transactions

$transactionCollection = $client->transaction()->get();

Retrieve a specific transaction

$txid = '111122223333';
$transactionResource = $client->transaction()->find($txid);

Retrieve all transactions with the 'receive' category sorted by amount ascending

$transactionCollection = $client->transaction()->filter('category', 'receive')->sort('amount')->get();

Retrieve a list of all withdrawals and then retrieving the next page of results

$withdrawalCollection = $client->withdrawal()->get();
$withdrawalCollection->next();

Request a withdrawal with an optional external_id set

$toAddress = '1111222233334444';
$externalId = 999;
$withdrawalResource = $client->withdrawal()->create(['symbol' => 'BTC', 'to' => $toAddress, 'amount' => 1.05, 'external_id' => $externalId]);

Confirm a withdrawal

$withdrawalId = '1111222233334444';
$withdrawalResource = $client->withdrawal()->find($withdrawalId);
$withdrawalResource->update(['action' => 'confirm']);

Cancel a withdrawal

$withdrawalId = '1111222233334444';
$withdrawalResource = $client->withdrawal()->find($withdrawalId);
$withdrawalResource->delete();

Retrieve all webhooks

$webhookCollection = $client->webhook()->get();

Create a webhook

$webhookResource = $client->webhook()->create(['url' => 'https://example.com/handlewebhook?api_token=12345']);

Retrieve available webhook triggers

$availableTriggers = $client->availableTriggers()->first();

Add a trigger to a webhook

$webhookId = '1111222233334444';
$trigger = 'transaction.confirmed';
$triggerResource = $client->trigger()->create(['webhook_id' => $webhookId, 'trigger' => $trigger]);