Disbursements

Represent Disbursements Client used for Disbursements product

Method

async createAccessToken()

async getAccountBalance()

async getAccountBalanceIn()

async getBasicUserInfo()

async askUserInfo()

async deposit()

async transfer()

async refund()

async getDepositStatus()

async getTransferStatus()

async getRefundStatus()

async isActive()

`awaitcreateAccessToken( authorization )`

Method to create access token for disbursements 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 )`

Method to get balance for disbursements user

Parameters :

authorization (string) - A valid bearer authentification token
target (string) - The target environment

Return :

[boolean, data]

{
  "availableBalance": "string",
  "currency": "string"
}

Return Type :

array

`await` `getAccountBalanceIn( currency, authorization, target )`

Method to get balance in specific currency for disbursements user

Parameters :

currency (string) - A valid ISO4217 Currency
authorization (string) - A valid bearer authentification token
target (string) - The target environment

Return :

[boolean, data]

{
  "availableBalance": "string",
  "currency": "string"
}

Return Type :

array

`await` `getBasicUserInfo( msisdn, authorization, target )`

Method to get basic user info without consent for disbursements user

Parameters :

msisdn (string) - The number of the user
authorization (string) - A valid bearer authentification token
target (string) - The target environment

Return :

[boolean, data]

{
  "given_name": "string",
  "family_name": "string",
  "birthdate": "string",
  "locale": "string",
  "gender": "string",
  "status": "string"
}

Return Type:

array

`await` `askUserInfo( authorization, target )`

Method to get user info with consent for disbursements user

Parameters :

authorization (string) - A valld bearer authentification token
target (string) - The target environment

Return :

[boolean, data]

{
  "sub": "string",
  "name": "string",
  "given_name": "string",
  "family_name": "string",
  "middle_name": "string",
  "email": "string",
  "email_verified": true,
  "gender": "string",
  "locale": "string",
  "phone_number": "string",
  "phone_number_verified": true,
  "address": "string",
  "updated_at": 0,
  "status": "string",
  "birthdate": "string",
  "credit_score": "string",
  "active": true,
  "country_of_birth": "string",
  "region_of_birth": "string",
  "city_of_birth": "string",
  "occupation": "string",
  "employer_name": "string",
  "identification_type": "string",
  "identification_value": "string"
}

Return Type :

array

`await` `deposit( uuid, authorization, target, body, urlCallback )`

Method to make deposit for disbursement user

The library is only taking in charge deposit V2

Parameters :

uuid (string) - A valid UUID version 4
authorization (string) - A valid bearer authentification token
target (string) - The target environment
body (Object) - A dictionnary with full detail of the payment [see detail below]

According to MTN MOMO API

{
  "amount": "string",
  "currency": "string",
  "externalId": "string",
  "payer": {
    "partyIdType": "MSISDN",
    "partyId": "string"
  },
  "payerMessage": "string",
  "payeeNote": "string"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "Amount that will be debited from the payer account."
    },
    "currency": {
      "type": "string",
      "description": "ISO4217 Currency"
    },
    "externalId": {
      "type": "string",
      "description": "External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique."
    },
    "payer": {
      "type": "object",
      "properties": {
        "partyIdType": {
          "enum": [
            "MSISDN",
            "EMAIL",
            "PARTY_CODE"
          ],
          "type": "string"
        },
        "partyId": {
          "type": "string"
        }
      },
      "description": "Party identifies a account holder in the wallet platform. Party consists of two parameters, type and partyId. Each type have its own validation of the partyId<br> MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN<br> EMAIL - Validated to be a valid e-mail format. Validated with IsEmail<br> PARTY_CODE - UUID of the party. Validated with IsUuid"
    },
    "payerMessage": {
      "type": "string",
      "description": "Message that will be written in the payer transaction history message field."
    },
    "payeeNote": {
      "type": "string",
      "description": "Message that will be written in the payee transaction history note field."
    }
  }
}

urlCallback ( [Optional] string ) - The website receiving call back

Return :

[boolean, data]

Retrun Type :

array

`await` `transfer( uuid, authorization, target, body, urlCallback )`

Method to transfer for disbursement user

Parameters :

uuid (string) - A valid UUID version 4
authorization (string) - A valid bearer authentification token
body (Object) - A dictionnary with full detail of the payment [see detail below]
urlCallback ( [Optional] string ) - The website receiving call back

Return :

[boolean, data]

Return Type :

array

`await` `getDepositStatus( uuid, authorization, target )`

Method to get a withdrawal status for collection user

Parameters :

uuid (string) - A valid UUID version 4
authorization (string) - A valid bearer authentification token
target (string) - The target environment

Return :

[boolean, data]

According to MTN MOMO API

{
  "amount": "string",
  "currency": "string",
  "financialTransactionId": "string",
  "externalId": "string",
  "payer": {
    "partyIdType": "MSISDN",
    "partyId": "string"
  },
  "payerMessage": "string",
  "payeeNote": "string",
  "status": "PENDING",
  "reason": {
    "code": "PAYEE_NOT_FOUND",
    "message": "string"
  }
}

Return Type:

array

`await` `refund( uuid, authorization, target, body, urlCallback )`

Method to transfer for disbursement user

The library is only taking in charge only Refund V2

Parameters :

uuid (string) - A valid UUID version 4
authorization (string) - A valid bearer authentification token
target (string) - The target environment
body (Object) - A dictionnary with full detail of the payment

According to MTN MOMO API

{
  "amount": "string",
  "currency": "string",
  "externalId": "string",
  "payerMessage": "string",
  "payeeNote": "string",
  "referenceIdToRefund": "UUID-REQUEST-TO-PAY"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "Amount that will be debited from the payer account."
    },
    "currency": {
      "type": "string",
      "description": "ISO4217 Currency"
    },
    "externalId": {
      "type": "string",
      "description": "External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique."
    },
    "payerMessage": {
      "type": "string",
      "description": "Message that will be written in the payer transaction history message field."
    },
    "payeeNote": {
      "type": "string",
      "description": "Message that will be written in the payee transaction history note field."
    },
    "referenceIdToRefund": {
      "type": "string",
      "description": "Format - UUID. Recource ID of the created refund transaction. This ID is used, for example, validating the status of the‘ ’transaction generated using UUID version 4."
    }
  }
}

urlCallback ( [Optional] string ) - The website receiving call back

Return :

[boolean, data]

Return Type :

array

`await` `getTransferStatus( uuid, authorization, target )`

Method to get transfer status for disbursement user

Parameters :

uuid (string) - A valid UUID version 4
authorization (string) - A valid bearer authentification token
target (string) - The target environment

Return :

[boolean, data]

According to MTN MOMO API

{
  "amount": "string",
  "currency": "string",
  "financialTransactionId": "string",
  "externalId": "string",
  "payee": {
    "partyIdType": "MSISDN",
    "partyId": "string"
  },
  "payerMessage": "string",
  "payeeNote": "string",
  "status": "PENDING",
  "reason": {
    "code": "PAYEE_NOT_FOUND",
    "message": "string"
  }
}

Return Type :

array

`await` `getRefundStatus( uuid, authorization, target )`

Method to get transfer status for disbursement user

Parameters :

uuid (string) - A valid UUID version 4
authorization (string) - A valid bearer authentification token
target (string) - The target environment

Return :

[boolean, data]

According to MTN MOMO API

{
  "amount": "string",
  "currency": "string",
  "financialTransactionId": "string",
  "externalId": "string",
  "payee": {
    "partyIdType": "MSISDN",
    "partyId": "string"
  },
  "payerMessage": "string",
  "payeeNote": "string",
  "status": "PENDING",
  "reason": {
    "code": "PAYEE_NOT_FOUND",
    "message": "string"
  }
}

Return Type :

array

`await` `isActive( account, accountType, authorization, target )`

Method to check if an account is active for a collection user

Parameters :

account (string) - The account target
accountType (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

PreviousCollection NextBody details

Last updated 3 years ago

awaitcreateAccessToken( authorization )

Parameters :

Return

Return Type :

await getAccountBalance( authorization, target )

Parameters :

Return :

Return Type :

await getAccountBalanceIn( currency, authorization, target )

Parameters :

Return :

Return Type :

await getBasicUserInfo( msisdn, authorization, target )

Parameters :

Return :

Return Type:

await askUserInfo( authorization, target )

Parameters :

Return :

Return Type :

await deposit( uuid, authorization, target, body, urlCallback )

Parameters :

Return :

Retrun Type :

await transfer( uuid, authorization, target, body, urlCallback )

Parameters :

Return :

Return Type :

await getDepositStatus( uuid, authorization, target )

Parameters :

Return :

Return Type:

await refund( uuid, authorization, target, body, urlCallback )

Parameters :

Return :

Return Type :

await getTransferStatus( uuid, authorization, target )

Parameters :

Return :

Return Type :

await getRefundStatus( uuid, authorization, target )

Parameters :

Return :

Return Type :

await isActive( account, accountType, authorization, target )

Parameters :

Return :

Return Type :

`awaitcreateAccessToken( authorization )`

`await` `getAccountBalance( authorization, target )`

`await` `getAccountBalanceIn( currency, authorization, target )`

`await` `getBasicUserInfo( msisdn, authorization, target )`

`await` `askUserInfo( authorization, target )`

`await` `deposit( uuid, authorization, target, body, urlCallback )`

`await` `transfer( uuid, authorization, target, body, urlCallback )`

`await` `getDepositStatus( uuid, authorization, target )`

`await` `refund( uuid, authorization, target, body, urlCallback )`

`await` `getTransferStatus( uuid, authorization, target )`

`await` `getRefundStatus( uuid, authorization, target )`

`await` `isActive( account, accountType, authorization, target )`