README

A powerful and professional PHP wrapper for integrating MTN Mobile Money and Airtel Money APIs. Supports Collection (receive payments) and Disbursement (send money) operations.

Features

Provider	Product	Supported Operations
MTN MoMo	Collection	Request payments, Check payment status, Check account holder, Get balance
MTN MoMo	Disbursement	Transfer money, Deposit funds, Process refunds, Check account holder, Get balance
MTN MoMo	Sandbox	Create API users, Generate API keys, Test environment support
Airtel Money	Collection	Request payments, Check payment status, Get balance
Airtel Money	Disbursement	Transfer money, Check transfer status, Get balance

Requirements

PHP 8.2 or higher
MTN MoMo Developer Account (Sign up) and/or Airtel Money API credentials

Installation

composer require lepresk/momo-api

Quick Start

Collection API (Receive Payments)

<?php
use Lepresk\MomoApi\MomoApi;

// Simple fluent configuration
$collection = MomoApi::collection([
    'environment' => 'sandbox', // or 'mtncongo', 'mtnuganda', etc.
    'subscription_key' => 'YOUR_SUBSCRIPTION_KEY',
    'api_user' => 'YOUR_API_USER',
    'api_key' => 'YOUR_API_KEY',
    'callback_url' => 'https://yourdomain.com/callback'
]);

// Quick payment - 3 parameters
$paymentId = $collection->quickPay('1000', '242068511358', 'ORDER-123');

// Check payment status
$transaction = $collection->getPaymentStatus($paymentId);

if ($transaction->isSuccessful()) {
    echo "Payment of {$transaction->getAmount()} received!";
}

Disbursement API (Send Money)

<?php
use Lepresk\MomoApi\MomoApi;
use Lepresk\MomoApi\Models\TransferRequest;

$disbursement = MomoApi::disbursement([
    'environment' => 'sandbox',
    'subscription_key' => 'YOUR_SUBSCRIPTION_KEY',
    'api_user' => 'YOUR_API_USER',
    'api_key' => 'YOUR_API_KEY',
    'callback_url' => 'https://yourdomain.com/callback'
]);

// Transfer money to a beneficiary
$transfer = TransferRequest::make('5000', '242068511358', 'SALARY-001');
$transferId = $disbursement->transfer($transfer);

// Check transfer status
$result = $disbursement->getTransferStatus($transferId);

Sandbox Setup

<?php
use Lepresk\MomoApi\MomoApi;
use Lepresk\MomoApi\Support\Uuid;

$momo = MomoApi::create(MomoApi::ENVIRONMENT_SANDBOX);
$subscriptionKey = 'YOUR_SANDBOX_SUBSCRIPTION_KEY';

// 1. Create API User
$uuid = Uuid::v4();
$callbackHost = 'https://yourdomain.com/callback';
$apiUser = $momo->sandbox($subscriptionKey)->createApiUser($uuid, $callbackHost);

// 2. Create API Key
$apiKey = $momo->sandbox($subscriptionKey)->createApiKey($apiUser);

// Now use these credentials for Collection/Disbursement

The sandbox accepts EUR only. Against the sandbox, requestToPay(), quickPay(), deposit(), transfer() and refund() send EUR whatever currency the request was built with (MomoApi::SANDBOX_CURRENCY), so the same XAF code runs in both environments. Outside the sandbox the request currency is sent as is.

Advanced Usage

Collection API - Full Example

use Lepresk\MomoApi\MomoApi;
use Lepresk\MomoApi\Models\PaymentRequest;

$collection = MomoApi::collection([
    'environment' => 'mtncongo',
    'subscription_key' => env('MOMO_SUBSCRIPTION_KEY'),
    'api_user' => env('MOMO_API_USER'),
    'api_key' => env('MOMO_API_KEY'),
    'callback_url' => 'https://yourdomain.com/webhook/momo'
]);

// Custom payment request
$request = new PaymentRequest(
    amount: '2500',
    currency: 'XAF',
    externalId: 'ORDER-456',
    payer: '242068511358',
    payerMessage: 'Payment for order #456',
    payeeNote: 'Thank you for your purchase'
);

$paymentId = $collection->requestToPay($request);

// Get account balance
$balance = $collection->getBalance();
echo "Available: {$balance->getAvailableBalance()} {$balance->getCurrency()}";

Disbursement API - Full Example

use Lepresk\MomoApi\MomoApi;
use Lepresk\MomoApi\Models\TransferRequest;
use Lepresk\MomoApi\Models\RefundRequest;

$disbursement = MomoApi::disbursement([...config...]);

// Transfer
$transfer = new TransferRequest(
    amount: '10000',
    currency: 'XAF',
    externalId: 'PAYOUT-789',
    payee: '242068511358',
    payerMessage: 'Monthly salary',
    payeeNote: 'Salary payment for June'
);
$transferId = $disbursement->transfer($transfer);

// Refund
$refund = RefundRequest::make('1000', $originalTransactionId, 'REFUND-123');
$refundId = $disbursement->refund($refund);

// Check balance
$balance = $disbursement->getBalance();

Airtel Money

Airtel Collection API (Receive Payments)

<?php
use Lepresk\MomoApi\AirtelApi;
use Lepresk\MomoApi\Models\AirtelConfig;

$collection = AirtelApi::collection('staging', AirtelConfig::collection(
    clientId: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET',
));

// Request a payment
$externalId = $collection->requestToPay('5000', '068511358', 'ORDER-001');

// Check payment status
$transaction = $collection->getPaymentStatus($externalId);

if ($transaction->isSuccessful()) {
    echo "Payment received! Airtel Money ID: " . $transaction->getAirtelMoneyId();
} elseif ($transaction->isPending()) {
    echo "Payment pending...";
}

// Check balance
$balance = $collection->getBalance();
echo "Available: {$balance->getAvailableBalance()} {$balance->getCurrency()}";

Airtel Disbursement API (Send Money)

<?php
use Lepresk\MomoApi\AirtelApi;
use Lepresk\MomoApi\Models\AirtelConfig;

$disbursement = AirtelApi::disbursement('production', AirtelConfig::disbursement(
    clientId: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET',
    encryptedPin: 'YOUR_ENCRYPTED_PIN',
));

// Transfer money
$externalId = $disbursement->transfer('10000', '068511358', 'PAY-001');

// Check transfer status
$transaction = $disbursement->getTransferStatus($externalId);

if ($transaction->isSuccessful()) {
    echo "Transfer completed!";
}

Airtel Disbursement PIN

The transfer endpoint takes an RSA-encrypted PIN, never the PIN itself:

use Lepresk\MomoApi\Support\AirtelPin;

$disbursement = AirtelApi::disbursement('production', AirtelConfig::disbursement(
    clientId: getenv('AIRTEL_CLIENT_ID'),
    clientSecret: getenv('AIRTEL_CLIENT_SECRET'),
    encryptedPin: AirtelPin::encrypt('1234', getenv('AIRTEL_PUBLIC_KEY')),
));

The key is accepted base64-encoded or as PEM.

Airtel Phone Numbers

Airtel expects a national MSISDN. Numbers are normalised for you — passing 242068511358 or 068511358 sends 068511358 either way. Phone::clean() is public if you need the same normalisation elsewhere.

Airtel Failures

Airtel reports business failures with HTTP 200 and status.success: false, so requestToPay() and transfer() throw a MomoException in that case rather than returning an externalId for a refused request.

Status codes: TS successful, TF failed, TIP and TI both pending.

Airtel Environments

Mode	URL	Use Case
`staging`	`https://openapiuat.airtel.cg`	Testing
`production`	`https://openapi.airtel.cg`	Production - Congo

Handling Callbacks

Callbacks are not signed. Neither MTN nor Airtel signs the request sent to your callback URL, and that URL is no secret: it travels in the X-Callback-Url header of every request. Anyone can call it with "status": "SUCCESSFUL". Never fulfil an order from the callback body. Treat the callback as a signal that something changed, then ask MTN or Airtel for the real status.

MTN MoMo

MTN sends the callback as a JSON body (PUT). Use it only to find the order, then re-query the payment with the reference id requestToPay() returned, which you stored with the order:

<?php
$payload = json_decode(file_get_contents('php://input'), true) ?? [];

// Look the order up in your own records; never trust the amount in the callback
$order = $orders->findByExternalId($payload['externalId'] ?? '');
if ($order === null) {
    http_response_code(404);
    exit;
}

// Ask MTN, with the reference id stored when the payment was requested
$transaction = $collection->getPaymentStatus($order->momoReferenceId);

if ($transaction->isSuccessful()
    && $transaction->getExternalId() === $order->id
    && (float) $transaction->getAmount() === (float) $order->amount
) {
    $order->markPaid();   // make this idempotent: MTN may call more than once
} elseif ($transaction->isFailed()) {
    $order->markFailed((string) $transaction->getReason());
}

http_response_code(200);

Airtel Money

Airtel's callback carries transaction.id, the externalId you passed to requestToPay(). Re-query it the same way:

<?php
$payload = json_decode(file_get_contents('php://input'), true) ?? [];

$order = $orders->findByExternalId($payload['transaction']['id'] ?? '');
if ($order === null) {
    http_response_code(404);
    exit;
}

// Ask Airtel; the callback's status_code is not proof of payment
$transaction = $airtelCollection->getPaymentStatus($order->id);

if ($transaction->isSuccessful()) {
    $order->markPaid();
} elseif ($transaction->isFailed()) {
    $order->markFailed((string) $transaction->getMessage());
}

http_response_code(200);

Transaction::parse() turns an array into a Transaction; it does not verify anything. Use it on data you fetched yourself, not on a callback you intend to act on.

Error Handling

use Lepresk\MomoApi\Exceptions\ResourceNotFoundException;
use Lepresk\MomoApi\Exceptions\InternalServerErrorException;
use Lepresk\MomoApi\Models\ErrorReason;

try {
    $paymentId = $collection->quickPay('1000', '242068511358', 'ORDER-999');
} catch (ResourceNotFoundException $e) {
    // Payment not found
    echo "Error: " . $e->getMessage();
} catch (InternalServerErrorException $e) {
    // Server error
    echo "Server error, please retry";
}

// Check error reason from transaction
$transaction = $collection->getPaymentStatus($paymentId);
if ($transaction->isFailed()) {
    $reason = $transaction->getReason();

    // isPayerFundingFailure() also covers LOW_BALANCE_OR_PAYEE_LIMIT_REACHED_OR_NOT_ALLOWED,
    // which MTN Congo returns instead of NOT_ENOUGH_FUNDS
    if ($reason !== null && $reason->isPayerFundingFailure()) {
        echo "Insufficient funds or limit reached";
    } elseif ($reason !== null) {
        echo "Failed: {$reason}";   // "[COULD_NOT_PERFORM_TRANSACTION]"
    }
}

Available Environments

Constant	Value	Use Case
`ENVIRONMENT_SANDBOX`	sandbox	Testing
`ENVIRONMENT_MTN_CONGO`	mtncongo	Production - Congo
`ENVIRONMENT_MTN_UGANDA`	mtnuganda	Production - Uganda
`ENVIRONMENT_MTN_GHANA`	mtnghana	Production - Ghana
`ENVIRONMENT_IVORY_COAST`	mtnivorycoast	Production - Ivory Coast
`ENVIRONMENT_ZAMBIA`	mtnzambia	Production - Zambia
`ENVIRONMENT_CAMEROON`	mtncameroon	Production - Cameroon
`ENVIRONMENT_BENIN`	mtnbenin	Production - Benin
`ENVIRONMENT_SWAZILAND`	mtnswaziland	Production - Swaziland
`ENVIRONMENT_GUINEACONAKRY`	mtnguineaconakry	Production - Guinea Conakry
`ENVIRONMENT_SOUTHAFRICA`	mtnsouthafrica	Production - South Africa
`ENVIRONMENT_LIBERIA`	mtnliberia	Production - Liberia

API Reference

Collection API

Method	Description
`requestToPay(PaymentRequest $request)`	Request payment from customer
`quickPay(string $amount, string $phone, string $ref)`	Quick payment helper
`getPaymentStatus(string $paymentId)`	Check payment status
`checkAccountHolder(string $phone)`	Check if MSISDN is active
`getBalance()`	Get account balance
`getAccessToken()`	Get OAuth token (auto-managed)

Disbursement API

Method	Description
`transfer(TransferRequest $request)`	Transfer money to beneficiary
`getTransferStatus(string $transferId)`	Check transfer status
`deposit(PaymentRequest $request)`	Deposit funds
`getDepositStatus(string $depositId)`	Check deposit status
`refund(RefundRequest $request)`	Refund a transaction
`getRefundStatus(string $refundId)`	Check refund status
`checkAccountHolder(string $phone)`	Check if MSISDN is active
`getBalance()`	Get account balance
`getAccessToken()`	Get OAuth token (auto-managed)

Airtel Collection API

Method	Description
`requestToPay(string $amount, string $phone, string $reference)`	Request payment from customer
`getPaymentStatus(string $externalId)`	Check payment status (returns `AirtelTransaction`)
`getBalance()`	Get account balance
`getAccessToken()`	Get OAuth token (cached automatically)

Airtel Disbursement API

Method	Description
`transfer(string $amount, string $phone, string $reference)`	Transfer money (requires `encryptedPin`)
`getTransferStatus(string $externalId)`	Check transfer status (returns `AirtelTransaction`)
`getBalance()`	Get account balance
`getAccessToken()`	Get OAuth token (cached automatically)

Sandbox API

Method	Description
`createApiUser(string $uuid, string $callback)`	Create sandbox API user
`getApiUser(string $uuid)`	Get API user details
`createApiKey(string $uuid)`	Generate API key

Testing

The package includes two types of tests:

Unit Tests - Fast tests with mocked HTTP responses:

composer test
# or run specific suite
vendor/bin/phpunit --testsuite Unit

Fixture Tests - Validate parsing of real MTN API responses:

vendor/bin/phpunit --testsuite Fixtures

Run PHPStan analysis:

composer phpstan

Production Notes

Never hardcode credentials - Use environment variables
Validate callbacks - Check transaction status via API, not just callback data
Handle webhooks asynchronously - Process in background queue
Log all transactions - Keep audit trail
Test thoroughly in sandbox before going live

Ecosystem

The same client is available for multiple languages:

Language	Package	Install
PHP	`lepresk/momo-api`	`composer require lepresk/momo-api`
Node.js / TypeScript	`@lepresk/momo-api`	`npm install @lepresk/momo-api`
Python	`mtn-momo-client`	`pip install mtn-momo-client`

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

Changelog

See CHANGELOG.md for the full history of changes.

License

MIT License - see LICENSE file for details.

Support

Documentation: MTN MoMo Developer Portal
Issues: GitHub Issues

lepresk / momo-api

Package info

Security

Statistics

README

Features

Requirements

Installation

Quick Start

Collection API (Receive Payments)

Disbursement API (Send Money)

Sandbox Setup

Advanced Usage

Collection API - Full Example

Disbursement API - Full Example

Airtel Money

Airtel Collection API (Receive Payments)

Airtel Disbursement API (Send Money)

Airtel Disbursement PIN

Airtel Phone Numbers

Airtel Failures

Airtel Environments

Handling Callbacks

MTN MoMo

Airtel Money

Error Handling

Available Environments

API Reference

Collection API

Disbursement API

Airtel Collection API

Airtel Disbursement API

Sandbox API

Testing

Production Notes

Ecosystem

Contributing

Changelog

License

Support