README

Automatically deposit funds to multiple users

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

composer require mtnmomo/disbursement

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/mtnmomo/disbursement/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: apiKeyQuery
$config = Mtn\Momo\Disbursement\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Mtn\Momo\Disbursement\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure API key authorization: apiKeyHeader
$config = Mtn\Momo\Disbursement\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Mtn\Momo\Disbursement\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');


$apiInstance = new Mtn\Momo\Disbursement\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$authorization = 'authorization_example'; // string | Basic authentication header containing API user ID and API key. Should be sent in as B64 encoded.
$x_target_environment = 'x_target_environment_example'; // string | The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
$x_callback_url = 'x_callback_url_example'; // string | URL to the server where the callback should be sent.
$scope = 'scope_example'; // string
$login_hint = 'login_hint_example'; // string
$access_type = 'access_type_example'; // string
$consent_valid_in = 56; // int
$client_notification_token = 'client_notification_token_example'; // string
$scope_instruction = 'scope_instruction_example'; // string

try {
    $result = $apiInstance->bcAuthorize($authorization, $x_target_environment, $x_callback_url, $scope, $login_hint, $access_type, $consent_valid_in, $client_notification_token, $scope_instruction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->bcAuthorize: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://sandbox.momodeveloper.mtn.com/disbursement

Class	Method	HTTP request	Description
DefaultApi	bcAuthorize	POST /v1_0/bc-authorize	bc-authorize
DefaultApi	createAccessToken	POST /token/	CreateAccessToken
DefaultApi	createOauth2Token	POST /oauth2/token/	CreateOauth2Token
DefaultApi	depositV1	POST /v1_0/deposit	Deposit-V1
DefaultApi	depositV2	POST /v2_0/deposit	Deposit-V2
DefaultApi	getAccountBalance	GET /v1_0/account/balance	GetAccountBalance
DefaultApi	getAccountBalanceInSpecificCurrency	GET /v1_0/account/balance/{currency}	GetAccountBalanceInSpecificCurrency
DefaultApi	getBasicUserinfo	GET /v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/basicuserinfo	GetBasicUserinfo
DefaultApi	getDepositStatus	GET /v1_0/deposit/{referenceId}	GetDepositStatus
DefaultApi	getRefundStatus	GET /v1_0/refund/{referenceId}	GetRefundStatus
DefaultApi	getTransferStatus	GET /v1_0/transfer/{referenceId}	GetTransferStatus
DefaultApi	getUserInfoWithConsent	GET /oauth2/v1_0/userinfo	GetUserInfoWithConsent
DefaultApi	refundV1	POST /v1_0/refund	Refund-V1
DefaultApi	refundV2	POST /v2_0/refund	Refund-V2
DefaultApi	transfer	POST /v1_0/transfer	Transfer
DefaultApi	validateAccountHolderStatus	GET /v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/active	ValidateAccountHolderStatus

Models

Authorization

Authentication schemes defined for the API:

apiKeyHeader

Type: API key
API key parameter name: Ocp-Apim-Subscription-Key
Location: HTTP header

apiKeyQuery

Type: API key
API key parameter name: subscription-key
Location: URL query string

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0
- Generator version: 7.9.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

mtnmomo / disbursement

Maintainers

Details