remitano/remitano-php

Remitano API Client

Maintainers

Details

github.com/remitano/remitano-php

Homepage

Source

Issues

Installs: 316

Dependents: 0

Suggesters: 0

Security: 0

Stars: 5

Watchers: 30

Forks: 7

Open Issues: 2

v1.0.3 2021-12-28 15:00 UTC

Requires

Requires (Dev)

MIT de19b7d50dc77867973f90b87f5d4485f72aede1

apiremitano

This package is not auto-updated.

Last update: 2025-03-19 06:56:52 UTC

README

Feel free to fork, modify & redistribute under the MIT license.

Installation

Via Composer

$ composer require remitano/remitano-php

Or clone this repository and include it in your project

Usage

Create API Key

Visit https://remitano.com/settings/api_key to create API key.

Get Authenticator secret

Visit https://remitano.com/settings/authenticator to get your authenticator secret.

Note: This is needed to perform actions which need 2FA authentication like withdrawals, otherwise, you won't need it.

Setup Remitano client

$client = new Remitano\Api\RemitanoClient([
    'apiKey'  => 'your-api-key',
    'apiSecret' => 'your-api-secret',
    'authenticatorSecret' => 'your-authenticator-secret'
]);

Payment gateway

Visit https://developers.remitano.com/api-explorer - Merchant section for more information.

Charges

Get
$merchant_charges = new Remitano\Api\Merchant\Charge($client);
$merchant_charges->get($id);
Create
  1. With coin currency:
$merchant_charges->create([
    "coin_currency" => "usdt",
    "coin_amount" => 10.99,
    "cancelled_or_completed_callback_url" =>"https://example.com/payments/callback?id=example",
    "description" => "Example charge"
]);

Note: For now, we only support usdt as the price coin currency.

  1. With fiat: We support fiat currency of 56 countries that Remitano are supporting, i.e., USD, AUD. (You could find entire list in our developer docs).
$merchant_charges->create([
    "fiat_currency" => "AUD",
    "fiat_amount" => 100.99,
    "cancelled_or_completed_callback_url" =>"https://example.com/payments/callback?id=example",
    "description" => "Example charge"
]);

Withdrawals

Get
$merchant_withdrawals = new Remitano\Api\Merchant\Withdrawal($client);
$merchant_withdrawals->get($id);
Create
  1. Withdraw to external coin address
$merchant_withdrawals->create([
    "merchant_withdrawal_ref" => "123",
    "coin_currency" => "btc",
    "coin_amount" => 1,
    "receiver_pay_fee" => true,
    "cancelled_or_completed_callback_url" => "http://sample.com/123/callback",
    "coin_address" => "3CpwViK5RAMzT8AmaMFHVHyfoyQSwNPB6y"
]);
  1. Withdraw to other remitano account
$merchant_withdrawals->create([
    "merchant_withdrawal_ref" => "123",
    "coin_currency" => "btc",
    "coin_amount" => 1,
    "receiver_pay_fee" => true,
    "cancelled_or_completed_callback_url" => "http://sample.com/123/callback",
    "remitano_username" => "receiver123",
    "remitano_phone_number" => "+234 1 123 4567"
]);

Callbacks

Charges

Whenever a charge is changed to completed or cancelled in our system:

  • we will send a POST request to charge.cancelled_or_completed_callback_url with remitano_id param.
  • if user is still on our site, we will also redirect user to object.cancelled_or_completed_callback_url with remitano_id param (GET request).

After receiving these callbacks, you could call $merchant_charges->get($params['remitano_id']) to get the updated information and process accordingly.

Withdrawals

Whenever a withdrawal is changed to completed or cancelled in our system:

  • we will send a POST request to withdrawal.cancelled_or_completed_callback_url with remitano_id param.

After receiving these callbacks, you could call $merchant_withdrawals->get($params['remitano_id']) to get the updated information and process accordingly.

Other API calls

Visit https://developers.remitano.com/api-explorer for more API specs, APIs can be called directly by using method get, post, put of $client

$client->get('users/coin_accounts');

$client->post('offers/best', [
    "country_code" => "my",
    "offer_type" => "buy",
    "coin_currency" => "btc",
    "coin_amount" => 1
]);

Errors

When receiving non 200-299 http code, an Error will be raised.

Sandbox testing

We have a Testnet at https://remidemo.com.

You could register an account there, then submit a request at this google form with your Remidemo username, so we could help to setup your testing account as a merchant.

After that, you could start your sandbox testing by setting ENV variable: putenv("REMITANO_SANDBOX=1").

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request