mpesa/com.github.jeffnyauke.mpesa.request/StkPushRequest

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

Parameters

businessShortCode

This is organizations shortcode (PayBill or BuyGoods - A 5 to 6-digit account number) used to identify an organization and receive the transaction. Sample: Shortcode (5 to 7 digits) e.g. 654321.

password

This is the password used for encrypting the request sent: A base64 encoded string. (The base64 string is a combination of Shortcode+Passkey+Timestamp).

timestamp

This is the Timestamp of the transaction, normally in the format of YEAR+MONTH+DATE+HOUR+MINUTE+SECOND (YYYYMMDDHHMMSS) Each part should be at least two digits apart from the year which takes four digits.

transactionType

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

amount

This is the Amount transacted normally a numeric value. Money that customer pays to the Shortcode. Only whole numbers are supported. Sample: 10.

phoneNumber

The Mobile Number to receive the STK Pin Prompt. This number can be the same as PartyA value above. MSISDN (12 digits Mobile Number). Sample: MSISDN (12 digits Mobile Number) e.g. 254XXXXXXXXX.

partyA

The phone number sending money. The parameter expected is a Valid Safaricom Mobile Number that is M-PESA registered in the format 254XXXXXXXXX. Sample: MSISDN (12 digits Mobile Number) e.g. 254XXXXXXXXX.

partyB

The organization receiving the funds. The parameter expected is a 5 to 6 digit as defined on the Shortcode description above. This can be the same as BusinessShortCode value above. Sample: Shortcode (5-7 digits).

callBackUrl

A CallBack URL is a valid secure URL that is used to receive notifications from M-Pesa API. It is the endpoint to which the results will be sent by M-Pesa API. Sample: https://ip or domain:port/path, e.g: https://mydomain.com/path, https://0.0.0.0:9090/path.

accountReference

This is an Alpha-Numeric parameter that is defined by your system as an Identifier of the transaction for CustomerPayBillOnline transaction type. Along with the business name, this value is also displayed to the customer in the STK Pin Prompt message. Maximum of 12 characters. Sample: Any combinations of letters and numbers.

transactionDesc

This is any additional information/comment that can be sent along with the request from your system. Maximum of 13 Characters. Sample: Any string between 1 and 13 characters.

Constructors

StkPushRequest

constructor(businessShortCode: String, passKey: String, timestamp: String = getDarajaTimestamp(), transactionType: StkPushTransactionType, amount: String, phoneNumber: String, partyA: String, partyB: String, callBackUrl: String, accountReference: String, transactionDesc: String)

constructor(businessShortCode: String, password: String, timestamp: String, transactionType: String, amount: String, phoneNumber: String, partyA: String, partyB: String, callBackUrl: String, accountReference: String, transactionDesc: String)