README

Enable remote collection of bills, fees or taxes

Installation & Usage

Requirements

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

Composer

  composer require mtnmomo/collection

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/collection/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\Collection\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Mtn\Momo\Collection\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure API key authorization: apiKeyHeader
$config = Mtn\Momo\Collection\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\Collection\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');


$apiInstance = new Mtn\Momo\Collection\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 | Bearer Token. Replace with a valid oauth2 token received from oauth2 token endpoint in Wallet Platform.
$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.

try {
    $result = $apiInstance->bcAuthorize($authorization, $x_target_environment, $x_callback_url);
    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/collection

Class	Method	HTTP request	Description
DefaultApi	bcAuthorize	POST /v1_0/bc-authorize	bc-authorize
DefaultApi	cancelInvoice	DELETE /v2_0/invoice/{referenceId}	CancelInvoice
DefaultApi	cancelPreApproval	DELETE /v1_0/preapproval/{preapprovalid}	CancelPreApproval
DefaultApi	createAccessToken	POST /token/	CreateAccessToken
DefaultApi	createInvoice	POST /v2_0/invoice	CreateInvoice
DefaultApi	createOauth2Token	POST /oauth2/token/	CreateOauth2Token
DefaultApi	createPayments	POST /v2_0/payment	CreatePayments
DefaultApi	getAccountBalance	GET /v1_0/account/balance	GetAccountBalance
DefaultApi	getAccountBalanceInSpecificCurrency	GET /v1_0/account/balance/{currency}	GetAccountBalanceInSpecificCurrency
DefaultApi	getApprovedPreApprovals	GET /v1_0/preapprovals/{accountHolderIdType}/{accountHolderId}	GetApprovedPreApprovals
DefaultApi	getBasicUserinfo	GET /v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/basicuserinfo	GetBasicUserinfo
DefaultApi	getInvoiceStatus	GET /v2_0/invoice/{x-referenceId}	GetInvoiceStatus
DefaultApi	getPaymentStatus	GET /v2_0/payment/{x-referenceId}	GetPaymentStatus
DefaultApi	getPreApprovalStatus	GET /v2_0/preapproval/{referenceId}	GetPreApprovalStatus
DefaultApi	getUserInfoWithConsent	GET /oauth2/v1_0/userinfo	GetUserInfoWithConsent
DefaultApi	preApproval	POST /v2_0/preapproval	PreApproval
DefaultApi	requestToWithdrawTransactionStatus	GET /v1_0/requesttowithdraw/{referenceId}	RequestToWithdrawTransactionStatus
DefaultApi	requestToWithdrawV1	POST /v1_0/requesttowithdraw	RequestToWithdraw-V1
DefaultApi	requestToWithdrawV2	POST /v2_0/requesttowithdraw	RequestToWithdraw-V2
DefaultApi	requesttoPay	POST /v1_0/requesttopay	RequesttoPay
DefaultApi	requesttoPayDeliveryNotification	POST /v1_0/requesttopay/{referenceId}/deliverynotification	RequesttoPayDeliveryNotification
DefaultApi	requesttoPayTransactionStatus	GET /v1_0/requesttopay/{referenceId}	RequesttoPayTransactionStatus
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 / collection

Maintainers

Details