hellovoid/orangepay-php

PHP library for the Orangepay API.

, _(*1)

Orangepay PHP API Client Library

This is the client library for the [Orangepay API][1]., _(*2)

Installation

Install the library using Composer. Please read the Composer Documentation if you are unfamiliar with Composer or dependency managers in general., _(*3)

composer require hellovoid/orangepay-php

Authentication

Use an API key to access your Orangepay account., _(*4)

use Hellovoid\Orangepay\Client;
use Hellovoid\Orangepay\Configuration;


$client = \Hellovoid\Orangepay\Client::create(
    \Hellovoid\Orangepay\Configuration::apiKey(
        $apiKey,
        $apiUrl
    )
);

Response

Every successful method request returns decoded from json array., _(*5)

Exceptions

It is recommended to handle exceptions in the event of a problem. Example:, _(*6)

use Hellovoid\Orangepay\Client;
use Hellovoid\Orangepay\Configuration;
use Hellovoid\Orangepay\Exception\UnauthorizedException;
use Hellovoid\Orangepay\Exception\ValidationException;
use Hellovoid\Orangepay\Exception\NotFoundException;
use Hellovoid\Orangepay\Exception\RateLimitException;
use Hellovoid\Orangepay\Exception\InternalServerException;
use Hellovoid\Orangepay\Exception\HttpException;


$client = \Hellovoid\Orangepay\Client::create(
    \Hellovoid\Orangepay\Configuration::apiKey(
        $apiKey,
        $apiUrl
    )
);
try {
    $charge = $client->initializeCharge([
        'amount'       => 10.00,
        'currency'     => 'USD',
        'pay_method'   => 'card',
        'description'  => 'Test description',
        'reference_id' => 'my_unique_reference_id',
        'email'        => 'client@domain.ltd',
    ]);
} catch (UnauthorizedException $exception) {

} catch (ValidationException $exception) {

} catch (NotFoundException $exception) {

} catch (RateLimitException $exception) {

} catch (InternalServerException $exception) {

} catch (HttpException $exception) {

}

Retrieve wallet balances #ref

$client->getBalance();

Charges #ref

List charges

Retrieve pagination of charges with maximum 200 items per page., _(*7)

$client->getCharges([
    'pay_method' => 'card',
    'start_date' => '2018-01-01',
    'end_date'   => '2018-01-02',
]);

Charge details #ref

Retrieve charge details, _(*8)

$client->getCharge($chargeId);

Initialization #ref

Create invoice for payment., _(*9)

$client->initializeCharge([
   'amount'             => 10.00,
   'currency'           => 'USD',
   'pay_method'         => 'card',
   'description'        => 'Test description',
   'reference_id'       => 'my-unique-reference-id',
   'email'              => 'client@domain.ltd',
   'return_success_url' => 'https://my-site.ltd/payment-gateway-success',
   'return_error_url'   => 'https://my-site.ltd/payment-gateway-error',
   'callback_url'       => 'https://my-site.ltd/payment-gateway-callback',
]);

Refunds #ref

Create refund request

Returns the specified amount to the payer in the payment currency., _(*10)

$client->refund([
    'charge_id' => '1499ae90-f860-11e6-a8b6-e74ae337c2e8',
    'amount'    => 10.00
]);

Transfers

List transfers

Retrieve pagination of transfers with maximum 200 items per page., _(*11)

$client->getTransfers([
    'pay_method' => 'card',
    'start_date' => '2018-01-01',
    'end_date'   => '2018-01-02',
]);

Transfer details #ref

Retrieve Transfer details, _(*12)

$client->getTransfer($transferId);

Transfer to card #ref

$client->transferToCard([
    'reference_id'      => 'my-unique-reference-id', // can be used as [#idempotency key](https://en.wikipedia.org/wiki/Idempotence)
    'amount'            => 10.00,
    'currency'          => 'USD',
    'description'       => 'Test description',
    'name'              => 'John Doe',
    'card_number'       => '4111111111111111',
    'card_expiry_month' => '02',
    'card_expiry_year'  => '19',
    'address_country'   => 'US',
    'address_city'      => 'New York',
    'address_line1'     => '123 East 169th Street Apt. 2A Bronx, NY 10456',
    'callback_url'      => 'https://my-site.ltd/payment-gateway-callback'
]);

There is an opportunity to make transfer to the payer, who made a payment earlier by using charge_id:, _(*13)

$client->transferToCard([
    'charge_id'         => '1173157c-db4d-11e7-9296-cec278b6b50a',
    'reference_id'      => 'my-unique-reference-id',
    'amount'            => 10.00,
    'currency'          => 'USD',
    'description'       => 'Test description',
    'address_country'   => 'US',
    'address_city'      => 'New York',
    'address_line1'     => '123 East 169th Street Apt. 2A Bronx, NY 10456',
]);

Transfer to bitcoin address #ref

Amount must be in satoshi (1 BTC = 100000000 satoshis)., _(*14)

$client->transferToBitcoinAddress([
    'reference_id' => 'my-unique-reference-id',
    'amount'       => 10000000, // 0.1 BTC
    'currency'     => 'BTC',
    'description'  => 'Test description',
    'address'      => '3**********FR',
]);

Rates #ref

Retrieve rates

$client->rates('BTC-EUR');