mpesa/com.github.jeffnyauke.mpesa.request/C2bRegisterRequest

C2bRegisterRequest

@Serializable

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

C2b register request

Constructors

C2bRegisterRequest

constructor(shortCode: String, c2bRegisterTransactionType: C2bRegisterTransactionType, confirmationUrl: String, validationUrl: String)

constructor(shortCode: String, responseType: String, confirmationUrl: String, validationUrl: String)

Properties

confirmationUrl

@SerialName(value = "ConfirmationUrl")

val confirmationUrl: String

This is the URL that receives the confirmation request from API upon payment completion.

responseType

@SerialName(value = "ResponseType")

val responseType: String

This parameter specifies what is to happen if for any reason the validation URL is not reachable. Note that, this is the default action value that determines what M-PESA will do in the scenario that your endpoint is unreachable or is unable to respond on time.

shortCode

@SerialName(value = "ShortCode")

val shortCode: String

Usually, a unique number is tagged to an M-PESA pay bill/till number of the organization. Sample: 123456

validationUrl

@SerialName(value = "ValidationUrl")

val validationUrl: String

This is the URL that receives the validation request from the API upon payment submission. The validation URL is only called if the external validation on the registered shortcode is enabled. (By default External Validation is disabled).