Transaction Events
Triggered when a transaction's status changes.
transaction_created:
{
"event": "transaction_created",
"data": {
"transactionId": "BeOfXV1NVIcZlsSVeQAF",
"status": "pending",
"type": "withdrew",
"externalReference": null
},
"timestamp": "2024-10-03T16:33:14.600Z"
}
transaction_updated:
{
"event": "transaction_updated",
"data": {
"transactionId": "string",
"status": "string",
"type": "string",
"externalReference": "string",
"stepRequired": "string", // optional e.g otp, redirect.
"redirectUrl": "https//test-redirect.com", // provided when stepRequired is "redirect"
"method": "string", // optional e.g momo, bank etc
"thirdPartReference": "string", // optional. e.g Mpesa reference
"note": "string" // optional. e.g error message
},
"timestamp": "ISO-8601 timestamp"
}
{
"event": "transaction_updated",
"data": {
"transactionId": "test123",
"status": "pending",
"type": "deposit",
"externalReference": "mnvmcvcmvlc",
"stepRequired": "redirect",
"redirectUrl": "https//test-redirect.com",
"method": "momo", // optional e.g momo, bank etc
},
"timestamp": "ISO-8601 timestamp"
}
{
"event": "transaction_updated",
"data": {
"transactionId": "test123",
"status": "pending",
"type": "deposit",
"externalReference": "mnvmcvcmvlc",
"stepRequired": "otp",
"method": "momo", // optional e.g momo, bank etc
},
"timestamp": "ISO-8601 timestamp"
}
Status Values:
pending
: Transaction is being processed.successful
: Transaction successfully completed.failed
: Transaction failed.
Type Values:
withdrew
: Payout transaction.deposit
: Deposit transaction.offramp
: An offramp (Crypto -> Fiat) transaction.
Updated 12 days ago