README

🌎 i18n: 🇺🇸 • 🇫🇷 • 🇭🇹

A library to facilitate Digicel MonCash mobile money integration on your PHP projects via their API. For now it handles the base (client) use cae. The merchant use cases wil be available soon. It is part of the MonCash SDK provided by FruitsBytes.

🍇Features

Client side Adapter (Payment, Transfer, ...)
- Render Button
- Payment
- Transfer
Traffic optimisation (Advanced)
Security: Secret Management (Advanced)
Unique orderID generator
Retry (Advanced)
Phone Validation (Advanced)
Client Button, No Backend (Encrypted, client side button)
Merchant App (Cash-In , Cash-Out, ...)
Idempotence (Advanced)
Localization (Advanced)
Task (Recurring payments, garbage collector,...)

Check the CHANGELOG for additional information on breaking changes and new features.

🍈Documentation

For a complete guide please check the Wiki or the code examples.

🍉Quick Start

Installation

composer require fruitsbytes/php-moncash

Configuration

// index.php

use Fruitsbytes\PHP\MonCash\API\Client;

$client = new Client(
                        [
                            'clientSecret'     => 'my-client-secret',
                            'clientId'         => 'my-client-key',
                            'businessKey'      => 'my-merchant-key',
                        ]
                    );

You can update or set the configuration:

use Fruitsbytes\PHP\MonCash\Configuration\Configuration;

$configuration = new Configuration(["lang"=>"ht"]);
$client = new Client($configuration);

The default no config value :

// src/Configuration/Configuration.php

 const DEFAULT_CONFIG = [
        'mode'             => 'sandbox',
        'lang'             => 'en',
        'clientSecret'     => '', 
        'clientId'         => '',
        'businessKey'      => '',
        'rsaPath'          => './rsa.text',
        'timeout'          => 60,
        'secretManager'    => DefaultSecretManager::class,
        'tokenMachine'     => FileTokenMachine::class,
        'phoneValidation'  => LibPhoneValidation::class,
        'orderIdGenerator' => UUIDOrderIdGenerator::class,
    ];

Usage

Client

For client facing websites and mobile app, where the client iniates the payment.

// Create a payment & redirect user
use Fruitsbytes\PHP\MonCash\API\Order;
use Fruitsbytes\PHP\MonCash\API\PaymentFoundResponse;
use Fruitsbytes\PHP\MonCash\API\PaymentFoundResponse;
use Fruitsbytes\PHP\MonCash\APIException;
use Exception;

try{
   $order = new Order($amount); // if you have your own orderID `new  Order($amount, $uuid)` 
   $payment = $client->createAndRedirect($order);
}catch( APIException $e){ 
   $message = $e->getMessage();
}
catch( Exception $e){ 
   $message = $e->getMessage();
}

// get payment by orderID if ypui do not habe the transation ID yet
/**
* @var PaymentFoundResponse
 */
$paymentResult = $client->getPaymentByOrderId($order->id);

// get payment by transactionID when transaction is finished
$transactionId = $_GET['transactionId']

/**
* @var PaymentFoundResponse
 */
$paymentResult = $client->getPaymentByTransactionId($transactionId);

if(!$payment->isSuccessful()){
  throw new \Exception($payment->message);
}

Button

The button, when clicked, will create the transaction and redirects the user to the

// Generate Button form html code
use Fruitsbytes\PHP\MonCash\Button\ButtonStyleRedResponsive;

$buttonConfig = [
     true, // border
     'em', //  lang
     true, // animate on  hover,
     48 // height
];
$button = new ButtonStyleRedResponsive( $order, $clientConfig, ...$buttonConfig);

$htmlButton = $button->html();
print($htmlButton);

// or Use the \Stringable interface
print $button;

You can render the template directly

$buttonHT = new ButtonStyleRedResponsive( $order, [], true, 'ht');

$buttonHT->render();

Button config Playground

Merchant

For applications aimed at store clerks or business owners where the client is present at the time of the transaction. It handles Cash-In and Cash-Out scenarios.

==== 🚧 Coming soon =====

🍊Playground

==== 🚧 Website Coming soon =====

You can check the Postman API online or import the .json from this repository.

🍍Contribution

All pull requests and suggestions are welcomed. If there is a particular feature you are struggling make a pull reque

🍒Test

When modifyiing To run the test use the following shell command from this directory.

Set the values of .env.testing environment file.

composer phpunit

vendor\bin\phpunit

⚠ Reduce credentials being leaked by not using production credentials for testing.

🍓Other

FruitsBytes MonCash SDK:

MonCash Documentation

Client Rest API ( client facing user interface)
- Button
Merchant Rest API (admin/merchant facing UI)
Dashboard: sandbox (for test) | production (live)

Offical Repo

ecelestin/ ecelestin-Moncash-sdk-php ✍ ing. Enadyre celeste

Online videos :

🍋Security

If you discover a security vulnerability within this package, please send an email to security@anbapyezanman.com. All security vulnerabilities will be addressed as soon as possible. You may view our full security policy here.

🍎Need help?

Don't hesitate to go in the discussion page and check if the issue is not addressed yet. You can start a new discussion if need be.

If you are an upcoming startup, a student or don't have the budget for consultation fees, it will take longer but we can submit a public repo illustrating the help you need as long as it will benefit the rest of the community:

For Enterprise

Fruitsbytes can deliver commercial support and maintenance for your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use.

🍏License

This library is licensed under The MIT License.

Discalimer

* The Digicel™, MonCash™, Sogebank™ and all other trademarks, logos and brand names are the property of their respective owners. All company, product and service names used in this documentation are for identification purposes only. Use of these names,trademarks and brands does not imply endorsement.

MonCash™ is a mobile money service provided by Digicel™ that allows daily transactions between MonCash users, regardless of their location in Haiti. Digicel is a pioneer in mobile money. Their financial services are currently expanding into other markets, specifically in the pacific island with MyCash™ [1] [2]

fruitsbytes / php-moncash

Maintainers

Details