HomeAPI Reference
Guides
DashboardBlogTalk to Us

Event Types

Suggest Edits

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.

EventDescription
customer.createdThis event is generated when a new customer account is successfully created in your organization.
customer.updatedThis event is generated when an existing customer account is successfully updated or modified.
virtualNuban.createdGenerated when a Virtual Account is successfully created. Virtual accounts are typically used for receiving and sending money to a subaccount or deposit account.
virtualNuban.closedThis event is generated when a Virtual Account is successfully closed or deactivated.
virtualNuban.creation.failedGenerated when there is a failure in creating a Virtual Account.
account.openedThis event is generated when a new account is successfully created.
account.closedThis event is generated when an account is successfully closed.
account.frozenGenerated when an account is frozen, usually due to suspicious activity or compliance issues.
account.unfrozenGenerated when a previously frozen account is unfrozen and can be used again.
account.creation.failedGenerated when there is a failure in creating a general account.
book.transfer.initiatedGenerated when the process of initiating a book transfer is started.
book.transfer.failedOn rare occassions, this event is generated when a book transfer fails for any reason.
book.transfer.successfulThis event is generated when Book Transfer is successful.
nip.transfer.initiatedGenerated when Nip Transfer is initiated.
nip.transfer.failedGenerated when Nip Transfer fails.
nip.transfer.successfulGenerated when Nip Transfer is successful.
nip.incomingTransfer.receivedGenerated when Incoming Transfer is Received.
document.approvedGenerated when a submitted Document is approved.
document.rejectedGenerated when a submitted Document is rejected.
customer.identification.approvedGenerated when a Customer Kyc is approved.
customer.identification.manualReviewGenerated when a Customer Kyc is pending manual review.
customer.identification.errorGenerated when a Customer Kyc fails due to an error.
payment.receivedGenerated when payment is received into a Virtual Account Number
payment.settledGenerated 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.completedGenerated when a Bulk Transfer is completed.
bulkTransfer.partiallyCompletedGenerated when a Bulk Transfer is partially completed i.e some transfers are still being re-queried to get final status
bulkTransfer.failedGenerated when a Bulk Transfer fails.
bulkTransfer.startedGenerated when a Bulk Transfer has started processing after validation.
nip.transfer.reversedGenerated when Nip Transfer is reversed.
customer.identification.rejectedGenerated when a Customer Kyc is rejected.
balance_summary.reporting.initiatedGenerated when a balance summary report is initiated
balance_summary.reporting.scheduledGenerated when a balance summary report is scheduled
balance_summary.reporting.completedGenerated when a balance summary report is completed
balance_summary.reporting.failedGenerated when a balance summary report fails
transaction_history.reporting.initiatedGenerated when a transaction history report is initiated
transaction_history.reporting.scheduledGenerated when a transaction history report is scheduled
transaction_history.reporting.completedGenerated when a transaction history report is completed
transaction_history.reporting.failedGenerated when a transaction history report fails
statement.initiatedGenerated when a statement report is initiated
statement.scheduledGenerated when a statement report is scheduled”
statement.completedGenerated when a statement report is completed
statement.failedGenerated when a statement report fails
sub_account.createdGenerated when a sub account is created
customer.identification.reenter_informationGenerated when a Customer Kyc information needs to be reentered
customer.identification.awaitingDocumentGenerated when a Customer Kyc requires a document to be submitted.
bills.failedGenerated when a bill payment fails
bills.initiatedGenerated when a bill payment is initiated
bills.successfulGenerated when a bill payment is successful
ach.initiatedGenerated when an ACH Transfer is initiated
ach.pending_submissionGenerated when an ACH Transfer is pending submission
ach.manual_reviewGenerated when an ACH Transfer is being reviewed
ach.submittedGenerated when an ACH Transfer has been submitted to the federal reserve
ach.settledGenerated when an ACH Transfer has been settled
ach.completedGenerated when an ACH Transfer has been completed
ach.cancelledGenerated when an ACH Transfer has been cancelled
ach.failedGenerated when an ACH Transfer has failed
ach.returnedGenerated when an ACH Transfer has been returned
ach.pending_cancellationGenerated when an ACH Transfer is pending cancellation
domestic.wire.initiatedGenerated when a Domestic Wire Transfer is initiated
domestic.wire.rejectedGenerated when a Domestic Wire Transfer is rejected
domestic.wire.submittedGenerated when a Domestic Wire Transfer has been submitted to the federal reserve
domestic.wire.completedGenerated when a Domestic Wire Transfer has been completed
domestic.wire.failedGenerated when a Domestic Wire Transfer has failed
domestic.wire.manual_reviewGenerated when a Domestic Wire Transfer is being reviewed
domestic.wire.pending_submissionGenerated when a Domestic Wire Transfer is pending submission to the federal reserve
international.wire.completedGenerated when an International Wire Transfer has been completed
international.wire.failedGenerated when an International Wire Transfer has failed
international.wire.initiatedGenerated when an International Wire Transfer is initiated
international.wire.manual-reviewGenerated when an International Wire Transfer is being reviewed
international.wire.rejectedGenerated when an International Wire Transfer is rejected by swift network, correspondent bank or beneficiary bank
international.wire.submittedGenerated when an International Wire Transfer has been submitted to the swift network
international.wire.pending_submissionGenerated when an International Wire Transfer is pending submission to the swift network

Updated about 1 year ago