Collection
Represent Collection Client used for collection product
async createAccessToken()
async getAccountBalance()
async getAccountBalanceIn()
async getBasicUserInfo()
async askUserInfo()
async requestToPay()
async getWithdrawStatus()
async withdraw()
async isActive()
await createAccessToken( authorization )
await createAccessToken( authorization )Method to create access token for collection user
Parameters :
authorization (string) - a valid basic authentification token
Return
[boolean, data]
{
"access_token": "string",
"token_type": "string",
"expires_in": 0
}Return Type :
array
await getAccountBalance( authorization, target )
await getAccountBalance( authorization, target )Method to get balance for collection user
Parameters :
authorization (string) - A valid bearer authentification token
target (string) - The target environment
Return :
[boolean, data]
Return Type :
array
await getAccountBalanceIn( currency, authorization, target )
await getAccountBalanceIn( currency, authorization, target )Method to get balance in specific currency for collection user
Parameters :
currency (string) - A valid ISO4217 Currency
authorization (string) - A valid bearer authentification token
target (string) - The target environment
Return :
[boolean, data]
Return Type :
array
await getBasicUserInfo( msisdn, authorization, target )
await getBasicUserInfo( msisdn, authorization, target )Method to get basic user info without consent for collection user
Parameters :
msisdn (string) - The number of the user
authorization (string) - A valid bearer authentification token
target (string) - The target environment
Return :
[boolean, data]
Return Type:
array
await askUserInfo( authorization, target )
await askUserInfo( authorization, target )Method to get user info with consent for collection user
Parameters :
authorization (string) - A valld bearer authentification token
target (string) - The target environment
Return :
[boolean, data]
Return Type :
array
await requestToPay( authorization, uuid, target, body, callback )
await requestToPay( authorization, uuid, target, body, callback )Method to request a payment for collection user
Parameters :
authorization (string) - A valid bearer authentification token
uuid (string) - A valid UUID version 4
target (string) - The target environment
body (Object) - A dictionnary with full detail of the payment [see detail below]
According to MTN MOMO API
callback ( [Optional] string ) - The website receiving call back
Return :
[boolean, data]
Retrun Type :
array
await getWithdrawStatus( authorization, uuid, target )
await getWithdrawStatus( authorization, uuid, target )Method to get a withdrawal status for collection user
Parameters :
authorization (string) - A valid bearer authentification token
uuid (string) - A valid UUID version 4
target (string) - The target environment
Return :
[boolean, data]
According to MTN MOMO API
Return Type:
array
await withdraw( authorization, uuid, target, body, callback )
await withdraw( authorization, uuid, target, body, callback )Method to withdraw money for collection user
The library is taking in charge only Withdraw V2
Parameters :
authorization (string) - A valid bearer authentification token
uuid (string) - A valid UUID version 4
target (string) - The target environment
body (Object) - A dictionnary with full detail of the payment [see detail below]
callback ( [Optional] string ) - The website receiving call back
Return :
[boolean, data]
Return Type :
array
await isActive( account, accountType, authorization, target )
await isActive( account, accountType, authorization, target )Method to check if an account is active for a collection user
Parameters :
account (string) - The account target
account_type (string) - Specifies the type of the party ID. Allowed values [msisdn, email, party_code]. default set to msisdn
authorization (string) - A valid bearer authentification token
target (string) - The target environment
Return :
[boolean, data]
Return Type :
array
Last updated