1. class
  2. Bmatovu
  3. \
  4. MtnMomo
  5. \
  6. Products
  7. \
  8. Disbursement

Disbursement

class Disbursement extends Product (View source)

Class Disbursement.

Constants

PRODUCT

Product.

Properties

protected Repository $config Configuration. from  Product
protected ClientInterface $client

HTTP client.

 from  Product
protected string $baseUri

Base URI.

 from  Product
protected string $tokenUri

Token URI.

 from  Product
protected string $subscriptionKey

Subscription key.

 from  Product
protected string $clientId

Client ID.

 from  Product
protected string $clientSecret

Client secret.

 from  Product
protected string $clientCallbackUri

Client callback URI.

 from  Product
protected string $currency Currency. from  Product
protected string $environment Environment. from  Product
protected string $partyIdType

Party ID type.

 from  Product
protected string $logFile

Log file.

 from  Product
protected string $transactionUri

Transact URI.
protected string $transactionStatusUri

Transaction status URI.
protected string $accountStatusUri

Account status URI.
protected string $accountBalanceUri

Account balance URI.
protected string $accountHolderInfoUri

Account holder basic info URI.

Methods

ClientInterface
getClient()

No description

from  Product
setClient(ClientInterface $client)

No description

from  Product
string
getBaseUri()

No description

from  Product
setBaseUri(string $baseUri)

No description

from  Product
string
getTokenUri()

No description

from  Product
setTokenUri(string $tokenUri)

No description

from  Product
string
getSubscriptionKey()

No description

from  Product
setSubscriptionKey(string $subscriptionKey)

No description

from  Product
string
getClientId()

No description

from  Product
setClientId(string $clientId)

No description

from  Product
string
getClientSecret()

No description

from  Product
setClientSecret(string $clientSecret)

No description

from  Product
string
getClientCallbackUri()

No description

from  Product
setClientCallbackUri(string $clientCallbackUri)

No description

from  Product
string
getCurrency()

No description

from  Product
setCurrency(string $currency)

No description

from  Product
string
getEnvironment()

No description

from  Product
setEnvironment(string $environment)

No description

from  Product
string
getPartyIdType()

No description

from  Product
setPartyIdType(string $partyIdType)

No description

from  Product
string
getLogFile()

No description

from  Product
setLogFile(string $logFile)

No description

from  Product
__construct(array $headers = [], array $middleware = [], ClientInterface $client = null)

Disbursement constructor.

array
getToken()

Request disbursement access token.

OAuth2Middleware
getAuthBroker(array $headers)

Get authentication broker.

from  Product
string
getTransactionUri()

No description

setTransactionUri(string $transactionUri)

No description

string
getTransactionStatusUri()

No description

setTransactionStatusUri(string $transactionStatusUri)

No description

string
getAccountStatusUri()

No description

setAccountStatusUri(string $accountStatusUri)

No description

string
getAccountBalanceUri()

No description

setAccountBalanceUri(string $accountBalanceUri)

No description

string
getAccountHolderInfoUri()

No description

setAccountHolderInfoUri(string $accountHolderInfoUri)

No description

string
transfer(string $transactionId, string $partyId, int $amount, string $payerMessage = '', string $payeeNote = '')

Transfer an amount to a payee account.

array
getTransactionStatus(string $momoTransactionId)

Get transaction status.

array
getAccountBalance()

Get account balance.

bool
isActive(string $partyId, string $partyIdType = null)

Determine if an account holder is registered and active.

array
getAccountHolderBasicInfo(string $partyId)

Get basic info of an account holder.

Details

in Product at line 117
ClientInterface getClient()

No description

Return Value

ClientInterface

in Product at line 125
setClient(ClientInterface $client)

No description

Parameters

ClientInterface $client

in Product at line 133
string getBaseUri()

No description

Return Value

string

in Product at line 141
setBaseUri(string $baseUri)

No description

Parameters

string $baseUri

in Product at line 149
string getTokenUri()

No description

Return Value

string

in Product at line 157
setTokenUri(string $tokenUri)

No description

Parameters

string $tokenUri

in Product at line 165
string getSubscriptionKey()

No description

Return Value

string

in Product at line 173
setSubscriptionKey(string $subscriptionKey)

No description

Parameters

string $subscriptionKey

in Product at line 181
string getClientId()

No description

Return Value

string

in Product at line 189
setClientId(string $clientId)

No description

Parameters

string $clientId

in Product at line 197
string getClientSecret()

No description

Return Value

string

in Product at line 205
setClientSecret(string $clientSecret)

No description

Parameters

string $clientSecret

in Product at line 213
string getClientCallbackUri()

No description

Return Value

string

in Product at line 221
setClientCallbackUri(string $clientCallbackUri)

No description

Parameters

string $clientCallbackUri

in Product at line 229
string getCurrency()

No description

Return Value

string

in Product at line 237
setCurrency(string $currency)

No description

Parameters

string $currency

in Product at line 245
string getEnvironment()

No description

Return Value

string

in Product at line 253
setEnvironment(string $environment)

No description

Parameters

string $environment

in Product at line 261
string getPartyIdType()

No description

Return Value

string

in Product at line 269
setPartyIdType(string $partyIdType)

No description

Parameters

string $partyIdType

in Product at line 277
string getLogFile()

No description

Return Value

string

in Product at line 285
setLogFile(string $logFile)

No description

Parameters

string $logFile

at line 154
__construct(array $headers = [], array $middleware = [], ClientInterface $client = null)

Disbursement constructor.

Parameters

array $headers
array $middleware
ClientInterface $client

Exceptions

Exception

at line 183
array getToken()

Request disbursement access token.

Return Value

array

Exceptions

GuzzleException

See also

https://momodeveloper.mtn.com/docs/services/disbursement/operations/token-POST Documentation

in Product at line 374
protected OAuth2Middleware getAuthBroker(array $headers)

Get authentication broker.

Parameters

array $headers

HTTP request headers

Return Value

OAuth2Middleware

Exceptions

Exception

at line 66
string getTransactionUri()

No description

Return Value

string

at line 74
setTransactionUri(string $transactionUri)

No description

Parameters

string $transactionUri

at line 82
string getTransactionStatusUri()

No description

Return Value

string

at line 90
setTransactionStatusUri(string $transactionStatusUri)

No description

Parameters

string $transactionStatusUri

at line 98
string getAccountStatusUri()

No description

Return Value

string

at line 106
setAccountStatusUri(string $accountStatusUri)

No description

Parameters

string $accountStatusUri

at line 114
string getAccountBalanceUri()

No description

Return Value

string

at line 122
setAccountBalanceUri(string $accountBalanceUri)

No description

Parameters

string $accountBalanceUri

at line 130
string getAccountHolderInfoUri()

No description

Return Value

string

at line 138
setAccountHolderInfoUri(string $accountHolderInfoUri)

No description

Parameters

string $accountHolderInfoUri

at line 218
string transfer(string $transactionId, string $partyId, int $amount, string $payerMessage = '', string $payeeNote = '')

Transfer an amount to a payee account.

Parameters

string $transactionId

Transaction reference ID.
string $partyId

Account holder. Usually phone number if type is MSISDN.
int $amount

How much to transfer to payee account.
string $payerMessage

Payer transaction history message.
string $payeeNote

Payee transaction history message.

Return Value

string

$momoTransactionId Auto generated payment reference. Format: UUID

Exceptions

DisbursementRequestException
GuzzleException
Exception

See also

https://momodeveloper.mtn.com/docs/services/disbursement/operations/transfer-POST Documentation

at line 265
array getTransactionStatus(string $momoTransactionId)

Get transaction status.

Parameters

string $momoTransactionId

That was returned by transfer (transferAmount)

Return Value

array

Exceptions

DisbursementRequestException
GuzzleException

See also

https://momodeveloper.mtn.com/docs/services/disbursement/operations/transfer-referenceId-GET Documentation

at line 292
array getAccountBalance()

Get account balance.

Return Value

array

Account balance.

Exceptions

DisbursementRequestException
GuzzleException

See also

https://momodeveloper.mtn.com/docs/services/disbursement/operations/get-v1_0-account-balance Documentation

at line 320
bool isActive(string $partyId, string $partyIdType = null)

Determine if an account holder is registered and active.

Parameters

string $partyId

Party number - MSISDN, email, or code - UUID.
string $partyIdType

Specifies the type of the account ID. Allowed values [msisdn, email, party_code].

Return Value

bool

True if account holder is registered and active, false if the account holder is not active or not found

Exceptions

DisbursementRequestException
GuzzleException

See also

https://momodeveloper.mtn.com/docs/services/disbursement/operations/get-v1_0-accountholder-accountholderidtype-accountholderid-active Documentation

at line 363
array getAccountHolderBasicInfo(string $partyId)

Get basic info of an account holder.

Parameters

string $partyId

Party number - MSISDN.

Return Value

array

account basic info

Exceptions

DisbursementRequestException
GuzzleException

See also

https://momodeveloper.mtn.com/docs/services/disbursement/operations/basicuserInfo-GET Documentation