mpesa/com.github.jeffnyauke.mpesa.request/AccountBalanceRequest

AccountBalanceRequest

@Serializable

data class AccountBalanceRequest(val initiator: String, val securityCredential: String, val commandId: String, val partyA: String, val identifierType: String, val resultUrl: String, val queueTimeOutUrl: String, val remarks: String)

Account balance request.

Parameters

initiator

This is the credential/username used to authenticate the transaction request. Sample: Testapi772.

securityCredential

Base64 encoded string of the M-PESA short code and password, which is encrypted using M-PESA public key and validates the transaction on M-PESA Core system. It indicates the Encrypted credential of the initiator getting the account balance. Its value must match the inputted value of the parameter IdentifierType.

commandId

A unique command is passed to the M-PESA system. Max length is 64. Sample: AccountBalance

partyA

The shortcode of the organization querying for the account balance. Sample: 60072

identifierType

Type of organization querying for the account balance.

resultUrl

It indicates the destination URL which Daraja should send the result message to.

queueTimeOutUrl

The end-point that receives a timeout message.

remarks

Comments that are sent along with the transaction. Sample: tests

Constructors

AccountBalanceRequest

constructor(initiator: String, securityCredential: String, partyA: String, accountBalanceOrganizationType: AccountBalanceOrganizationType, resultUrl: String, queueTimeOutUrl: String, remarks: String)

constructor(initiator: String, securityCredential: String, commandId: String, partyA: String, identifierType: String, resultUrl: String, queueTimeOutUrl: String, remarks: String)