ReversalInput
Defined in: src/modules/reversal/types.ts:13
Properties
Section titled “Properties”amount
Section titled “amount”amount:
number
Defined in: src/modules/reversal/types.ts:17
Amount to reverse.
commandId?
Section titled “commandId?”
optionalcommandId:"TransactionReversal"
Defined in: src/modules/reversal/types.ts:36
Optional command ID override. Defaults to TransactionReversal.
occasion?
Section titled “occasion?”
optionaloccasion:string
Defined in: src/modules/reversal/types.ts:25
Optional occasion or business context.
queueTimeOutUrl
Section titled “queueTimeOutUrl”queueTimeOutUrl:
string
Defined in: src/modules/reversal/types.ts:21
Timeout callback URL.
receiverIdentifierType?
Section titled “receiverIdentifierType?”
optionalreceiverIdentifierType:number
Defined in: src/modules/reversal/types.ts:34
Optional receiver identifier type.
Common values are 4 for organization/shortcode and 1 for MSISDN.
receiverParty?
Section titled “receiverParty?”
optionalreceiverParty:string
Defined in: src/modules/reversal/types.ts:29
Optional receiver party override. Defaults to the configured shortcode.
remarks
Section titled “remarks”remarks:
string
Defined in: src/modules/reversal/types.ts:23
Remarks sent with the reversal request.
resultUrl
Section titled “resultUrl”resultUrl:
string
Defined in: src/modules/reversal/types.ts:19
Result callback URL.
shortCode?
Section titled “shortCode?”
optionalshortCode:string
Defined in: src/modules/reversal/types.ts:27
Optional shortcode override. Defaults to configured shortcode.
transactionId
Section titled “transactionId”transactionId:
string
Defined in: src/modules/reversal/types.ts:15
Original M-Pesa transaction ID to reverse.