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.

Parameters

initiator

The name of the initiator to initiate the request.

securityCredential

Encrypted Credential of the user getting transaction amount.

commandId

Takes only the 'TransactionReversal' Command id.

transactionId

This is the Mpesa Transaction ID of the transaction which you wish to reverse.

amount

The amount transacted in the transaction is to be reversed, down to the cent.

receiverParty

The organization that receives the transaction. Sample: Shortcode (6-9 digits).

receiverIdentifierType

Type of organization receiving the transaction.

resultUrl

The path that stores information about the transaction.

queueTimeOutUrl

The path that stores information of the time-out transaction.

remarks

Comments that are sent along with the transaction.

occasion

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

Constructors

Link copied to clipboard
constructor(initiator: String, securityCredential: String, transactionId: String, amount: String, receiverParty: String, transactionReversalReceiverOrganizationType: TransactionReversalReceiverOrganizationType, resultUrl: String, queueTimeOutUrl: String, remarks: String, occasion: String)
constructor(initiator: String, securityCredential: String, commandId: String, transactionId: String, amount: String, receiverParty: String, receiverIdentifierType: String, resultUrl: String, queueTimeOutUrl: String, remarks: String, occasion: String)

Properties

Link copied to clipboard
@SerialName(value = "Amount")
val amount: String
Link copied to clipboard
@SerialName(value = "CommandID")
val commandId: String
Link copied to clipboard
@SerialName(value = "Initiator")
val initiator: String
Link copied to clipboard
@SerialName(value = "Occasion")
val occasion: String
Link copied to clipboard
@SerialName(value = "QueueTimeOutURL")
val queueTimeOutUrl: String
Link copied to clipboard
@SerialName(value = "ReceiverIdentifierType")
val receiverIdentifierType: String
Link copied to clipboard
@SerialName(value = "ReceiverParty")
val receiverParty: String
Link copied to clipboard
@SerialName(value = "Remarks")
val remarks: String
Link copied to clipboard
@SerialName(value = "ResultURL")
val resultUrl: String
Link copied to clipboard
@SerialName(value = "SecurityCredential")
val securityCredential: String
Link copied to clipboard
@SerialName(value = "TransactionID")
val transactionId: String