mpesa/com.github.jeffnyauke.mpesa.request

Package-level declarations

Types

enum AccountBalanceOrganizationType : Enum<AccountBalanceOrganizationType>

Type of organization receiving the transaction.

@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.

B2cCommandId

enum B2cCommandId : Enum<B2cCommandId>

This is a unique command that specifies B2C transaction type.

B2cRequest

@Serializable

data class B2cRequest(val initiatorName: String, val securityCredential: String, val commandId: String, val amount: Float, val partyA: String, val partyB: String, val resultUrl: String, val queueTimeOutUrl: String, val remarks: String, val occasion: String)

B2c request

C2bCommandId

enum C2bCommandId : Enum<C2bCommandId>

This is the transaction type that is used to identify the transaction when sending the request to M-PESA.

C2bRegisterRequest

@Serializable

data class C2bRegisterRequest(val shortCode: String, val responseType: String, val confirmationUrl: String, val validationUrl: String)

C2b register request

C2bRegisterTransactionType

enum C2bRegisterTransactionType : Enum<C2bRegisterTransactionType>

C2bRequest

@Serializable

data class C2bRequest(val shortCode: String, val commandId: String, val amount: String, val msisdn: String, val billRefNumber: String)

C2b request

DynamicQrRequest

@Serializable

data class DynamicQrRequest(val merchantName: String, val refNo: String, val amount: String, val trxCode: String, val cpi: String)

Dynamic QR request

DynamicQrTransactionType

enum DynamicQrTransactionType : Enum<DynamicQrTransactionType>

Dynamic QR transaction type.

StkPushQueryRequest

@Serializable

data class StkPushQueryRequest(val businessShortCode: String, val password: String, val timestamp: String, val checkoutRequestId: String)

Stk push query request

StkPushRequest

@Serializable

data class StkPushRequest(val businessShortCode: String, val password: String, val timestamp: String, val transactionType: String, val amount: String, val phoneNumber: String, val partyA: String, val partyB: String, val callBackUrl: String, val accountReference: String, val transactionDesc: String)

Stk push request

StkPushTransactionType

enum StkPushTransactionType : Enum<StkPushTransactionType>

This is the transaction type that is used to identify the transaction when sending the request to M-PESA.

TransactionReversalReceiverOrganizationType

enum TransactionReversalReceiverOrganizationType : Enum<TransactionReversalReceiverOrganizationType>

Type of organization receiving the transaction.

TransactionReversalRequest

@Serializable

data class TransactionReversalRequest(val initiator: String, val securityCredential: String, val commandId: String, val transactionId: String, val amount: String, val receiverParty: String, val receiverIdentifierType: String, val resultUrl: String, val queueTimeOutUrl: String, val remarks: String, val occasion: String)

Transaction reversal request.

TransactionStatusOrganizationType

enum TransactionStatusOrganizationType : Enum<TransactionStatusOrganizationType>

Type of organization receiving the transaction.

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.