Banking Audit Log
Tenant-scoped, append-only audit trail for all banking domain events.
The banking audit log records every significant action in the banking layer: wallet lifecycle events, transaction state changes, fee/limit configuration changes, and suspense resolutions. It is separate from the platform-level audit log (which tracks admin HTTP requests).
The audit log is append-only. Events are recorded automatically by the banking services. There are no write endpoints. You can only query it.
Tracked actions
| Action | Resource | When | Details |
|---|---|---|---|
wallet.created | wallet | New wallet opened | productCode, ownerId, currency, tier |
wallet.frozen | wallet | Wallet frozen | oldStatus, newStatus, reason |
wallet.unfrozen | wallet | Wallet unfrozen | oldStatus, newStatus, reason |
wallet.closed | wallet | Wallet closed | oldStatus, newStatus, reason |
wallet.tier_upgraded | wallet | KYC tier changed | oldTier, newTier |
transaction.initiated | transaction | Withdrawal started | type, walletId, amount, currency, channel |
transaction.completed | transaction | Deposit or withdrawal confirmed | type, walletId, amount, fee, currency |
transaction.failed | transaction | Withdrawal cancelled | type, walletId, reason |
transfer.completed | transfer | Transfer between wallets | senderWalletId, receiverWalletId, amount, currency |
product.created | product | New wallet product | code, name, currency |
product.updated | product | Product config changed | code, name |
fee_schedule.created | fee_schedule | Fee schedule created | name, transactionType, calculationType, currency |
fee_schedule.updated | fee_schedule | Fee schedule modified | name |
fee_schedule.deleted | fee_schedule | Fee schedule removed | name |
limit.created | limit | Limit rule created | transactionType, period, maxAmount, currency |
limit.updated | limit | Limit rule modified | maxAmount, isActive |
suspense.matched | suspense | Suspense matched to wallet | walletId, amount, currency, channel |
suspense.refunded | suspense | Suspense refunded to source | amount, currency, channel |
The BankingAuditEvent object
{
"id": "bae_01HZ...",
"actorId": "deposit-webhook",
"actorType": "api_key",
"action": "transaction.completed",
"resourceType": "transaction",
"resourceId": "btx_01HZ...",
"details": {
"type": "Deposit",
"walletId": "wal_01HZ...",
"amount": 50000,
"fee": 500,
"currency": "GHS"
},
"ipAddress": "10.0.1.42",
"createdAt": "2026-04-07T12:00:00Z"
}Prop
Type
List audit events
GET
/api/v1/banking/auditCursor-based pagination, newest first.
Query parameters
Prop
Type
curl "https://api.shiwake.example.com/api/v1/banking/audit?resourceType=wallet&action=wallet.created&size=20" \
-H "X-Api-Key: sk_live_..."Useful query patterns
All events for a specific wallet:
GET /api/v1/banking/audit?resourceType=wallet&resourceId=wal_01HZ...All completed transactions today:
GET /api/v1/banking/audit?action=transaction.completed&from=2026-04-07All configuration changes (fees + limits):
GET /api/v1/banking/audit?resourceType=fee_schedule
GET /api/v1/banking/audit?resourceType=limitGet a single event
GET
/api/v1/banking/audit/{id}curl "https://api.shiwake.example.com/api/v1/banking/audit/bae_01HZ..." \
-H "X-Api-Key: sk_live_..."Banking audit vs platform audit
| Banking audit | Platform audit | |
|---|---|---|
| Scope | Tenant-scoped | Cross-tenant |
| Trigger | Domain services | HTTP middleware |
| Endpoint | /api/v1/banking/audit | /api/v1/platform/audit |
| Auth | Tenant API key | Platform admin JWT |
| What it tracks | Wallet/transaction/config events | Admin HTTP mutations |
Edit on GitHub
Last updated on