PHPackages                             hellovoid/orangepay-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. hellovoid/orangepay-php

ActiveLibrary[API Development](/categories/api)

hellovoid/orangepay-php
=======================

PHP library for the Orangepay API.

1.0.0(7y ago)04.6kMITPHPPHP >=5.5.0

Since Jun 5Pushed 7y ago1 watchersCompare

[ Source](https://github.com/hellovoid/orangepay-php)[ Packagist](https://packagist.org/packages/hellovoid/orangepay-php)[ RSS](/packages/hellovoid-orangepay-php/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

[![Latest Stable Version](https://camo.githubusercontent.com/10c92610c32ed3855982557f772d9effb120e52060d7d21c5ff8476a5370b190/68747470733a2f2f706f7365722e707567782e6f72672f68656c6c6f766f69642f6f72616e67657061792d7068702f762f737461626c65)](https://packagist.org/packages/hellovoid/orangepay-php)[![Total Downloads](https://camo.githubusercontent.com/2c08a5d164792478477e4f671aa7051bb0ead46f27ac913e92b17a6b095b62d3/68747470733a2f2f706f7365722e707567782e6f72672f68656c6c6f766f69642f6f72616e67657061792d7068702f646f776e6c6f616473)](https://packagist.org/packages/hellovoid/orangepay-php)[![License](https://camo.githubusercontent.com/18be65314f00fb61a90e95dcc1b2fc23d9b06731719698dd59078b40dcc29d0d/68747470733a2f2f706f7365722e707567782e6f72672f68656c6c6f766f69642f6f72616e67657061792d7068702f6c6963656e7365)](https://packagist.org/packages/hellovoid/orangepay-php)

Orangepay PHP API Client Library
================================

[](#orangepay-php-api-client-library)

This is the client library for the [Orangepay API](https://orange-pay.com/api).

Installation
------------

[](#installation)

Install the library using Composer. Please read the [Composer Documentation](https://getcomposer.org/doc/01-basic-usage.md) if you are unfamiliar with Composer or dependency managers in general.

```
composer require hellovoid/orangepay-php

```

Authentication
--------------

[](#authentication)

Use an API key to access your Orangepay account.

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

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

Response
--------

[](#response)

Every successful method request returns decoded from json array.

Exceptions
----------

[](#exceptions)

It is recommended to handle exceptions in the event of a problem. Example:

```
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](https://docs.gdax.com/#balances)
-----------------------------------------------------------------

[](#retrieve-wallet-balances-ref)

```
$client->getBalance();
```

Charges [\#ref](https://orange-pay.com/api#charges)
---------------------------------------------------

[](#charges-ref)

### List charges

[](#list-charges)

Retrieve pagination of charges with maximum 200 items per page.

ParameterDescriptionpay\_methodRequest charges of provided type, for example: card, bitcoin, etc. (Optional, default null)start\_dateRequest charges after provided date in Y-m-d format. (Required)end\_dateRequest charges after provided date in Y-m-d format (Required)pagePagination cursor```
$client->getCharges([
    'pay_method' => 'card',
    'start_date' => '2018-01-01',
    'end_date'   => '2018-01-02',
]);
```

### Charge details [\#ref](https://orange-pay.com/api#retrieve-charge-details)

[](#charge-details-ref)

Retrieve charge details

```
$client->getCharge($chargeId);
```

### Initialization [\#ref](https://orange-pay.com/api#initialization)

[](#initialization-ref)

Create invoice for payment.

```
$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](https://www.orange-pay.com/api#refunds)
-------------------------------------------------------

[](#refunds-ref)

### Create refund request

[](#create-refund-request)

Returns the specified amount to the payer in the payment currency.

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

Transfers
---------

[](#transfers)

### List transfers

[](#list-transfers)

Retrieve pagination of transfers with maximum 200 items per page.

ParameterDescriptionpay\_methodRequest transfers of provided type, for example: card, bitcoin, etc. (Optional, default null)start\_dateRequest transfers after provided date in Y-m-d format. (Required)end\_dateRequest transfers after provided date in Y-m-d format (Required)pagePagination cursor```
$client->getTransfers([
    'pay_method' => 'card',
    'start_date' => '2018-01-01',
    'end_date'   => '2018-01-02',
]);
```

### Transfer details [\#ref](https://orange-pay.com/api#retrieve-transfer-details)

[](#transfer-details-ref)

Retrieve Transfer details

```
$client->getTransfer($transferId);
```

### Transfer to card [\#ref](https://www.orange-pay.com/api#transfer-to-card)

[](#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:

```
$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](https://www.orange-pay.com/api#transfer-to-bitcoin)
---------------------------------------------------------------------------------------

[](#transfer-to-bitcoin-address-ref)

Amount must be in satoshi (1 BTC = 100000000 satoshis).

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

Rates [\#ref](https://www.orange-pay.com/api#rates)
---------------------------------------------------

[](#rates-ref)

### Retrieve rates

[](#retrieve-rates)

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

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2901d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/02bd0bd4488ec76d1b7e90670bf31f5ec40c6c74ce8cb5ed792ba91ef4744cfa?d=identicon)[hellovoid](/maintainers/hellovoid)

---

Top Contributors

[![hellovoid](https://avatars.githubusercontent.com/u/7906586?v=4)](https://github.com/hellovoid "hellovoid (2 commits)")

---

Tags

apiorangepayapiorangepay

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/hellovoid-orangepay-php/health.svg)

```
[![Health](https://phpackages.com/badges/hellovoid-orangepay-php/health.svg)](https://phpackages.com/packages/hellovoid-orangepay-php)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[get-stream/stream-chat

A PHP client for Stream Chat (https://getstream.io/chat/)

301.8M2](/packages/get-stream-stream-chat)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)