Accounts
This section describes events that will be triggered for accounts and sub-accounts
Account and Sub-Account Events
EVENT | DESCRIPTION |
---|---|
banking.account.created | A new account is created. This account will be in the PENDING_DEPOSIT_ADDRESS state. |
banking.account.activated | The account has been activated. A deposit account has been assigned, and its status is now ACTIVE |
banking.sub-account.activated | A sub-account is activated. A deposit account has been assigned, and its status is now ACTIVE |
banking.sub-account.frozen | A sub-account is frozen |
banking.sub-account.unfrozen | A sub-account is unfrozen |
Event Data
{
"id": "0196ad53-ed99-7456-8464-e996d01fa113",
"timestamp": 1746664364910,
"event": "banking.account.created",
"data": {
"id": "0196c3bc-22d1-7dc6-b677-23768d1a38d5",
"state": "PENDING_DEPOSIT_ADDRESS",
"created_date": "2025-05-12T09:03:28.977Z",
"updated_date": "2025-05-12T09:03:28.989Z",
"currency": "NGN",
"name": "My Institution",
"type": "VIRTUAL_EXTERNAL",
"deposit_addresses": [],
"balances": {
"available": 0,
"pending": 0
}
}
{
"id": "0196ad53-ed99-7456-8464-e996d01fa113",
"timestamp": 1746664364910,
"event": "banking.account.activated",
"data": {
"id": "0196c3bc-22d1-7dc6-b677-23768d1a38d5",
"state": "ACTIVE",
"created_date": "2025-05-12T09:03:28.977Z",
"updated_date": "2025-05-12T09:03:28.989Z",
"currency": "NGN",
"name": "My Institution",
"type": "VIRTUAL_EXTERNAL",
"deposit_addresses": [
{
"type": "NUBAN",
"data": {
"nip_code": "169615",
"bank_code": "684762",
"bank_name": "Waza Bank",
"account_name": "My Institution",
"account_number": "7817057252"
}
}
],
"balances": {
"available": 0,
"pending": 0
}
}
{
"id": "0196ad53-ed99-7456-8464-e996d01fa113",
"timestamp": 1746664364910,
"event": "banking.sub-account.activated",
"data": {
"id": "0196c3bc-22d1-7dc6-b677-23768d1a38d5",
"state": "ACTIVE",
"created_date": "2025-05-12T09:03:28.977Z",
"updated_date": "2025-05-12T09:03:28.989Z",
"currency": "NGN",
"name": "Roberts - Collins",
"type": "VIRTUAL_EXTERNAL",
"deposit_addresses": [
{
"type": "NUBAN",
"data": {
"nip_code": "169615",
"bank_code": "684762",
"bank_name": "Waza Bank",
"account_name": "Roberts - Collins",
"account_number": "7817057252"
}
}
],
"balances": {
"available": 0,
"pending": 0
},
"classification": "customer",
"customer": {
"id": "0196c3bc-22a1-764d-8624-8fc460f075fd",
"name": "Roberts - Collins",
"client_reference": "test-ref"
}
}
{
"id": "0196ad53-ed99-7456-8464-e996d01fa113",
"timestamp": 1746664364910,
"event": "banking.sub-account.frozen",
"data": {
"id": "0196c3bc-22d1-7dc6-b677-23768d1a38d5",
"state": "FROZEN",
"reason": "FRAUD",
"created_date": "2025-05-12T09:03:28.977Z",
"updated_date": "2025-05-12T09:03:28.989Z",
"currency": "NGN",
"name": "Roberts - Collins",
"type": "VIRTUAL_EXTERNAL",
"deposit_addresses": [
{
"type": "NUBAN",
"data": {
"nip_code": "169615",
"bank_code": "684762",
"bank_name": "Waza Bank",
"account_name": "Roberts - Collins",
"account_number": "7817057252"
}
}
],
"balances": {
"available": 0,
"pending": 0
},
"classification": "customer",
"customer": {
"id": "0196c3bc-22a1-764d-8624-8fc460f075fd",
"name": "Roberts - Collins",
"client_reference": "test-ref"
}
}
{
"id": "0196ad53-ed99-7456-8464-e996d01fa113",
"timestamp": 1746664364910,
"event": "banking.sub-account.unfrozen",
"data": {
"id": "0196c3bc-22d1-7dc6-b677-23768d1a38d5",
"state": "ACTIVE",
"created_date": "2025-05-12T09:03:28.977Z",
"updated_date": "2025-05-12T09:03:28.989Z",
"currency": "NGN",
"name": "Roberts - Collins",
"type": "VIRTUAL_EXTERNAL",
"deposit_addresses": [
{
"type": "NUBAN",
"data": {
"nip_code": "169615",
"bank_code": "684762",
"bank_name": "Waza Bank",
"account_name": "Roberts - Collins",
"account_number": "7817057252"
}
}
],
"balances": {
"available": 0,
"pending": 0
},
"classification": "customer",
"customer": {
"id": "0196c3bc-22a1-764d-8624-8fc460f075fd",
"name": "Roberts - Collins",
"client_reference": "test-ref"
}
}
Account Event Object
Field | Data Type | Description |
---|---|---|
id | string | Unique identifier for the webhook event (UUID format) |
event | string | Account event type |
timestamp | number | Unix timestamp in milliseconds when the event was generated |
data | object | An object containing the account data. The Account Object or Sub Account Object |
Updated 2 months ago