Event Types
The following is a list of event types that we currently capture and send. Please note that while we strive to be comprehensive, this list may not include all events as we are constantly adding new ones to our system.
| Event | Description |
|---|---|
| customer.created | This event is generated when a new customer account is successfully created in your organization. |
| customer.updated | This event is generated when an existing customer account is successfully updated or modified. |
| accountNumber.created | Generated when a Account Number is successfully created. Account accounts are typically used for receiving and sending money to a deposit account. |
| account.opened | This event is generated when a new account is successfully created. |
| account.closed | This event is generated when an account is successfully closed. |
| account.frozen | Generated when an account is frozen, usually due to suspicious activity or compliance issues. |
| account.unfrozen | Generated when a previously frozen account is unfrozen and can be used again. |
| account.creation.failed | Generated when there is a failure in creating a general account. |
| book.transfer.initiated | Generated when the process of initiating a book transfer is started. |
| book.transfer.failed | On rare occassions, this event is generated when a book transfer fails for any reason. |
| book.transfer.successful | This event is generated when Book Transfer is successful. |
| nip.inbound.received | This event is sent when there's a pending bank transfer into a deposit account. This means money is about to be deposited to your account. |
| nip.inbound.completed | This is received when the funds is settled into the deposit account. You can listen to this event to give value to your customers. |
| nip.transfer.initiated | Generated when Nip Transfer is initiated. |
| nip.transfer.failed | Generated when Nip Transfer fails. |
| nip.transfer.successful | Generated when Nip Transfer is successful. |
| nip.incomingTransfer.received | Generated when Incoming Transfer is Received. |
| document.approved | Generated when a submitted Document is approved. |
| document.rejected | Generated when a submitted Document is rejected. |
| customer.identification.approved | Generated when a Customer Kyc is approved. |
| customer.identification.manualReview | Generated when a Customer Kyc is pending manual review. |
| customer.identification.error | Generated when a Customer Kyc fails due to an error. |
| payin.received | This event is sent when a reserved account receives a bank transfer. |
| payment.received | Generated when payment is received into a Virtual Account Number. |
| payment.settled | Generated when payment received into a virtual account Number is settled into deposit account. When the money is settled into the deposit account the virtual nuban is attached to, we send you payment.settled event. |
| bulkTransfer.completed | Generated when a Bulk Transfer is completed. |
| bulkTransfer.partiallyCompleted | Generated when a Bulk Transfer is partially completed i.e some transfers are still being re-queried to get final status. |
| bulkTransfer.failed | Generated when a Bulk Transfer fails. |
| bulkTransfer.started | Generated when a Bulk Transfer has started processing after validation. |
| nip.transfer.reversed | Generated when Nip Transfer is reversed. |
| customer.identification.rejected | Generated when a Customer Kyc is rejected. |
| balance_summary.reporting.initiated | Generated when a balance summary report is initiated. |
| balance_summary.reporting.scheduled | Generated when a balance summary report is scheduled. |
| balance_summary.reporting.completed | Generated when a balance summary report is completed. |
| balance_summary.reporting.failed | Generated when a balance summary report fails. |
| transaction_history.reporting.initiated | Generated when a transaction history report is initiated. |
| transaction_history.reporting.scheduled | Generated when a transaction history report is scheduled. |
| transaction_history.reporting.completed | Generated when a transaction history report is completed. |
| transaction_history.reporting.failed | Generated when a transaction history report fails. |
| statement.initiated | Generated when a statement report is initiated. |
| statement.scheduled | Generated when a statement report is scheduled”. |
| statement.completed | Generated when a statement report is completed. |
| statement.failed | Generated when a statement report fails. |
| sub_account.created | Generated when a sub account is created. |
| customer.identification.reenter_information | Generated when a Customer Kyc information needs to be reentered. |
| customer.identification.awaitingDocument | Generated when a Customer Kyc requires a document to be submitted. |
| bills.failed | Generated when a bill payment fails. |
| bills.initiated | Generated when a bill payment is initiated. |
| bills.successful | Generated when a bill payment is successful. |