PHPackages                             loucov/laravel-moncash-api - 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. [Payment Processing](/categories/payments)
4. /
5. loucov/laravel-moncash-api

ActiveLibrary[Payment Processing](/categories/payments)

loucov/laravel-moncash-api
==========================

Laravel package to integrate the Digicel Haiti MonCash payment gateway (payments, transfers, transaction lookup).

v3.2.0(2mo ago)046MITPHPPHP ^8.1

Since Mar 27Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/LouCov/laravel-moncash-api)[ Packagist](https://packagist.org/packages/loucov/laravel-moncash-api)[ Docs](https://github.com/LouCov/laravel-moncash-api)[ RSS](/packages/loucov-laravel-moncash-api/feed)WikiDiscussions main Synced 2d ago

READMEChangelogDependencies (6)Versions (10)Used By (0)

 [![loucov](https://raw.githubusercontent.com/LouCov/laravel-moncash-api/dev/.github/assets/logo.png)](https://raw.githubusercontent.com/LouCov/laravel-moncash-api/dev/.github/assets/logo.png)

Laravel MonCash API
===================

[](#laravel-moncash-api)

A Laravel package to integrate the Digicel Haiti **MonCash** payment gateway: create payments, look up transactions, and send transfers — all behind a clean, injectable API.

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

[](#installation)

```
composer require loucov/laravel-moncash-api
```

Laravel auto-discovers the service provider and the `MoncashApi` facade. No manual registration is needed.

**Everything is wired up automatically.** During the `package:discover` step that Laravel runs after every `composer install` / `composer update`, the package:

- publishes `config/moncash.php` to your application (only if it doesn't exist yet)
- appends its environment variables to your `.env` and `.env.example` files
- registers a `pre-package-uninstall` Composer hook so removal is equally automatic

All writes are **idempotent**, **atomic** (temp file + `rename()`), and **permission-preserving**.

After installation, fill in the required values in your `.env` file:

```
MONCASH_CLIENT_ID=your-client-id    # required
MONCASH_SECRET_KEY=your-secret-key  # required
MONCASH_SANDBOX=true                # required — flip to `false` for live mode
```

> `MONCASH_SANDBOX` defaults to `true` so fresh installs always point at the sandbox gateway. Flipping it to `false` is an explicit decision you should make before going to production.

If you ever want to re-run the installer manually — for example on a fresh clone where `.env` was just created from `.env.example` — use:

```
php artisan moncash:install
```

### Publishing the config

[](#publishing-the-config)

The config is published automatically on install. To publish or re-publish it manually:

```
# publish (skip if the file already exists)
php artisan vendor:publish --tag=moncash-config

# overwrite an existing published config
php artisan vendor:publish --tag=moncash-config --force
```

### Available environment variables

[](#available-environment-variables)

VariableRequiredDefaultPurpose`MONCASH_CLIENT_ID`**yes**—OAuth client id`MONCASH_SECRET_KEY`**yes**—OAuth client secret`MONCASH_SANDBOX`**yes**`true``true` for sandbox, `false` for live`MONCASH_BUSINESS_KEY`no—Optional business key`MONCASH_HTTP_TIMEOUT`no`15`HTTP timeout (seconds)`MONCASH_HTTP_RETRIES`no`2`Retries on transient network failures`MONCASH_HTTP_RETRY_WAIT`no`200`Wait between retries (ms)Uninstallation
--------------

[](#uninstallation)

Removal is **automatic**. When you run:

```
composer remove loucov/laravel-moncash-api
```

Composer fires the registered `pre-package-uninstall` hook before deleting the vendor files. The hook:

1. Removes `config/moncash.php`
2. Removes all `MONCASH_*` variables from `.env` and `.env.example`
3. Removes itself from your `composer.json`

To trigger the same cleanup manually (without removing the package), run:

```
php artisan moncash:uninstall
```

Usage
-----

[](#usage)

You can use the package in three equivalent ways. Pick whichever fits your codebase best.

### 1. Facade

[](#1-facade)

```
use LouCov\LaravelMonCashApi\Facades\MoncashApi;

$response = MoncashApi::payment(1000, 'ORDER-123');

return redirect($response->redirectUrl);
```

### 2. Dependency injection

[](#2-dependency-injection)

```
use LouCov\LaravelMonCashApi\MoncashApi;

public function checkout(MoncashApi $moncash)
{
    $response = $moncash->payment(1000, 'ORDER-123');

    return redirect($response->redirectUrl);
}
```

### 3. Container resolution

[](#3-container-resolution)

```
$moncash = app(\LouCov\LaravelMonCashApi\MoncashApi::class);
$response = $moncash->payment(1000, 'ORDER-123');
```

### Available methods

[](#available-methods)

#### `payment(int $amount, string $orderId): PaymentResponse`

[](#paymentint-amount-string-orderid-paymentresponse)

Create a new payment request. Redirects the customer to the MonCash hosted payment page.

```
$payment = $moncash->payment(1000, 'ORDER-123');

$payment->redirectUrl;      // string  — redirect the user here
$payment->token();          // string  — the payment token (shortcut)
$payment->mode;             // string  — 'sandbox' | 'live'
$payment->path;             // string  — gateway path used
$payment->timestamp;        // int     — Unix timestamp of the response
$payment->toArray();        // array   — structured response body
$payment->raw;              // array   — raw API response
```

`$payment->paymentToken` is a typed `PaymentToken` object that exposes the full token payload returned by the API:

```
$token = $payment->paymentToken;

$token->token;                    // string  — the raw token string
$token->created;                  // string  — creation date as returned by the API
$token->expired;                  // string  — expiration date as returned by the API

$token->createdAt();              // Carbon  — creation date
$token->expiredAt();              // Carbon  — expiration date
$token->isExpired();              // bool    — true if the token is past its expiry
$token->secondsUntilExpiry();     // int     — seconds left (negative when expired)

$token->toArray();                // array{token, created, expired}
```

Example — redirect only if the token is still valid:

```
$payment = $moncash->payment(1000, 'ORDER-123');

if ($payment->paymentToken->isExpired()) {
    // Token already expired (edge case — tokens are valid for ~10 minutes)
    abort(408);
}

return redirect($payment->redirectUrl);
```

#### `paymentDetailsByTransactionId(string $transactionId): TransactionResponse`

[](#paymentdetailsbytransactionidstring-transactionid-transactionresponse)

#### `paymentDetailsByOrderId(string $orderId): TransactionResponse`

[](#paymentdetailsbyorderidstring-orderid-transactionresponse)

Look up a completed payment.

```
$tx = $moncash->paymentDetailsByTransactionId('TXN-456');
// or
$tx = $moncash->paymentDetailsByOrderId('ORDER-123');

$tx->transactionId();   // ?string
$tx->reference();       // ?string
$tx->cost();            // ?int    — amount in HTG
$tx->message();         // ?string — gateway status message
$tx->payer();           // ?string — payer's MonCash number
$tx->toArray();         // array
$tx->raw;               // array   — raw API response
```

#### `transfer(int $amount, string $receiver, string $desc = ''): TransferResponse`

[](#transferint-amount-string-receiver-string-desc---transferresponse)

Send money from the business wallet to a MonCash account.

```
$transfer = $moncash->transfer(500, '509-xxxx-xxxx', 'Salary');

$transfer->transactionId();  // ?string
$transfer->amount();         // ?int    — amount transferred
$transfer->receiver();       // ?string — recipient's MonCash number
$transfer->toArray();        // array
$transfer->raw;              // array   — raw API response
```

### Error handling

[](#error-handling)

All failures throw typed exceptions — no more mixed response shapes:

```
use LouCov\LaravelMonCashApi\Exceptions\MoncashException;
use LouCov\LaravelMonCashApi\Exceptions\AuthenticationException;
use LouCov\LaravelMonCashApi\Exceptions\MoncashConnectionException;
use LouCov\LaravelMonCashApi\Exceptions\MoncashRequestException;

try {
    $response = MoncashApi::payment(1000, 'ORDER-123');
} catch (AuthenticationException $e) {
    // Wrong MONCASH_CLIENT_ID / MONCASH_SECRET_KEY.
} catch (MoncashConnectionException $e) {
    // Network / TLS / timeout error.
} catch (MoncashRequestException $e) {
    // The API returned a non-success status.
    $e->context(); // carries the raw API response body
} catch (MoncashException $e) {
    // Catch-all for any other MonCash package error.
}
```

Security
--------

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Louco COVIL](http://www.linkedin.com/in/loucov)

License
-------

[](#license)

MIT. See [LICENSE](LICENSE).

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance84

Actively maintained with recent releases

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity56

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

Every ~107 days

Recently: every ~1 days

Total

8

Last Release

81d ago

Major Versions

2.x-dev → v3.0.12026-04-11

### Community

Maintainers

![](https://www.gravatar.com/avatar/6b2182959c69a96fe43ec8b30a0ea67a91bbb6b04b61d655e129d492a6227f1f?d=identicon)[LouCov](/maintainers/LouCov)

---

Top Contributors

[![LouCov](https://avatars.githubusercontent.com/u/49552432?v=4)](https://github.com/LouCov "LouCov (30 commits)")

---

Tags

laravelpaymentgatewaymoncashLouCovdigicelhaiti

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/loucov-laravel-moncash-api/health.svg)

```
[![Health](https://phpackages.com/badges/loucov-laravel-moncash-api/health.svg)](https://phpackages.com/packages/loucov-laravel-moncash-api)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

77022.3M151](/packages/laravel-mcp)[api-platform/laravel

API Platform support for Laravel

58171.6k14](/packages/api-platform-laravel)[defstudio/telegraph

A laravel facade to interact with Telegram Bots

816333.9k3](/packages/defstudio-telegraph)[illuminate/auth

The Illuminate Auth package.

10528.2M1.2k](/packages/illuminate-auth)[spatie/laravel-export

Create a static site bundle from a Laravel app

674146.0k6](/packages/spatie-laravel-export)

PHPackages © 2026

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