EVENT DESCRIPTION banking.deposit.pendingThe deposit into an Account with deposit address capabilities has been settled. Associated with Accounts of type VIRTUAL_EXTERNAL banking.deposit.settledThe deposit into an Account with deposit address capabilities has been settled. Associated with Accounts of type VIRTUAL_EXTERNAL banking.prefund.settledA deposit into an Account of type VIRTUAL_WALLET has been settled into the balance
JSON
{
"id": "0196910c-ea1b-7e35-bfa1-9dd5cacd76f8",
"event": "banking.deposit.settled",
"timestamp": 1746189127535,
"data": {
"id": "01961ef1-b671-74c9-97d4-a3aa37e93651",
"state": "COMPLETED",
"status_description": "Deposit completed successfully",
"created_date": "2025-04-10T09:04:39.537Z",
"updated_date": "2025-04-10T09:04:39.951Z",
"completion_date": "2025-04-10T09:04:39.503Z",
"type": "BANK_TRANSFER",
"internal_reference": "wz-payin-g8kV-1744275879536",
"client_metadata": {},
"account_id": "01961ef1-b21c-79ea-a3f3-4764c3b988ba",
"gross_amount": {
"value": 1000000000,
"currency": "NGN"
},
"total_fees": {
"value": 0,
"currency": "NGN"
},
"settled_amount": {
"value": 1000000000,
"currency": "NGN"
},
"narration": "Sandbox deposit",
"sender": {
"type": "SWIFT",
"bank_name": "Waza Bank",
"swift_code": "WAZANGUS33",
"account_number": "1234567890"
},
"deposit_references": [
{
"type": "GENERIC",
"value": "0480713436883861"
}
],
"balance_before": {
"value": 0,
"currency": "NGN"
},
"balance_after": {
"value": 1000000000,
"currency": "NGN"
}
}
}Field Data Type Description idstringUnique identifier for the webhook event (UUID format) eventstringType of event see deposit events timestampnumberUnix timestamp in milliseconds when the event was generated dataobjectAn object containing data about the deposit See section below
This document describes the structure of deposit payload.
Field Type Description idstringUnique identifier for the deposit created_atstringTimestamp when the deposit was created updated_atstringTimestamp when the deposit was last updated statestringCurrent status of the deposit status_descriptionstringHuman-readable description of the deposit status completion_datestringTimestamp when the deposit was completed account_idstringUnique identifier of the account receiving the deposit internal_referencestringSystem-generated reference for the deposit client_metadatastringAdditional metadata provided by the sender typestringType of deposit see deposit type
Field Type Description typeenumType of deposit transaction
Possible values:
BANK_TRANSFER - Standard bank transfer depositWALLET_PREFUND - Internal wallet funding transaction
Field Type Description gross_amountobjectTotal amount of the deposit before fees total_feesobjectFees deducted from the deposit settled_amountobjectNet amount credited to the account
Field Type Description valuenumberAmount in minor units (kobo, cents, pence...) currencystringThe Currency code for the value e.g "NGN", "USD"
Field Type Description narrationstringAdditional notes about the deposit sender_referencestringReference provided by the sender senderobjectInformation about the sending party
The sender object contains:
Field Type Description idstringUnique identifier of the sender typestringType of sender (e.g., "CounterParty") namestringName of the sender detailsstringAdditional details about the sender
Field Type Description provider_referencesArray List of system identifiers for tracking
Each provider reference contains:
Field Type Description typestringType of the reference valuestringValue of the reference
Common reference types include:
TRANSACTION_ID - Provider's transaction identifierBATCH_ID - Batch processing identifierSESSION_ID - Session identifier
Field Type Description on_behalf_of_accountobjectOptional sub-account details
This field is present when a deposit is received on behalf of a sub-account managed by the institution.:
Field Type Description idstringUnique Identifier of the sub-account
