mpesa/com.github.jeffnyauke.mpesa.request/TransactionStatusRequest

TransactionStatusRequest

@Serializable

data class TransactionStatusRequest(val initiator: String, val securityCredential: String, val commandId: String, val transactionId: String, val originatorConversationId: String, val partyA: String, val identifierType: String, val resultUrl: String, val queueTimeOutUrl: String, val remarks: String, val occasion: String)

Transaction status request.

Parameters

initiator

The name of the initiator initiating the request. Sample: This is the credential/username used to authenticate the transaction request.

securityCredential

Encrypted credential of the user getting transaction status. Sample: Encrypted password for the initiator to authenticate the transaction request.

commandId

Takes only the 'TransactionStatusQuery' Command ID.

transactionId

Unique identifier to identify a transaction on Mpesa. Sample: LXXXXXX1234.

originatorConversationId

This is a global unique identifier for the transaction request returned by the API proxy upon successful request submission. If you don’t have the M-PESA transaction ID you can use this to query. Sample: AG_20190826_0000777ab7d848b9e721.

partyA

Organization/MSISDN receiving the transaction. Sample: Shortcode (6-9 digits) MSISDN (12 Digits).

identifierType

Type of organization receiving the transaction. Sample: TransactionStatusOrganizationType.BuyGoods.

resultUrl

The path that stores information of a transaction. Sample: https://ip:port/path or domain:port/path.

queueTimeOutUrl

The path that stores information of timeout transaction. Sample: https://ip:port/path or domain:port/path.

remarks

Comments that are sent along with the transaction. Sample: A sequence of characters up to 100.

occasion

Optional parameter. Sample: A sequence of characters up to 100.

Constructors

TransactionStatusRequest

constructor(initiator: String, securityCredential: String, transactionId: String, originatorConversationId: String, partyA: String, transactionStatusOrganizationType: TransactionStatusOrganizationType, resultUrl: String, queueTimeOutUrl: String, remarks: String, occasion: String)

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