ShiwakeDocs

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

ActionResourceWhenDetails
wallet.createdwalletNew wallet openedproductCode, ownerId, currency, tier
wallet.frozenwalletWallet frozenoldStatus, newStatus, reason
wallet.unfrozenwalletWallet unfrozenoldStatus, newStatus, reason
wallet.closedwalletWallet closedoldStatus, newStatus, reason
wallet.tier_upgradedwalletKYC tier changedoldTier, newTier
transaction.initiatedtransactionWithdrawal startedtype, walletId, amount, currency, channel
transaction.completedtransactionDeposit or withdrawal confirmedtype, walletId, amount, fee, currency
transaction.failedtransactionWithdrawal cancelledtype, walletId, reason
transfer.completedtransferTransfer between walletssenderWalletId, receiverWalletId, amount, currency
product.createdproductNew wallet productcode, name, currency
product.updatedproductProduct config changedcode, name
fee_schedule.createdfee_scheduleFee schedule createdname, transactionType, calculationType, currency
fee_schedule.updatedfee_scheduleFee schedule modifiedname
fee_schedule.deletedfee_scheduleFee schedule removedname
limit.createdlimitLimit rule createdtransactionType, period, maxAmount, currency
limit.updatedlimitLimit rule modifiedmaxAmount, isActive
suspense.matchedsuspenseSuspense matched to walletwalletId, amount, currency, channel
suspense.refundedsuspenseSuspense refunded to sourceamount, 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/audit

Cursor-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-07

All configuration changes (fees + limits):

GET /api/v1/banking/audit?resourceType=fee_schedule
GET /api/v1/banking/audit?resourceType=limit

Get 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 auditPlatform audit
ScopeTenant-scopedCross-tenant
TriggerDomain servicesHTTP middleware
Endpoint/api/v1/banking/audit/api/v1/platform/audit
AuthTenant API keyPlatform admin JWT
What it tracksWallet/transaction/config eventsAdmin HTTP mutations
Edit on GitHub

Last updated on

On this page