Skip to main content

Notifications

Ikawaari includes merchant-facing notifications for operational activity across payments, payouts, billing, and related account events.

Implemented merchant routes

Current notification routes include:

  • GET /api/v1/merchant/notifications
  • POST /api/v1/merchant/notifications/{id}/read
  • GET /api/v1/merchant/settings/alerts
  • PATCH /api/v1/merchant/settings/alerts

Legacy-compatible merchant paths may also be available under api/merchant/*.

What notifications cover

Merchant notifications should be treated as an operational inbox for:

  • payment state changes
  • payout state changes
  • account or onboarding actions
  • app and integration alerts
  • merchant configuration reminders

List notifications

GET /api/v1/merchant/notifications?limit=25&cursor=...
ParameterTypeDescription
limitintegerMaximum number of notifications to return
cursorstringCursor for incremental retrieval

Mark a notification as read

POST /api/v1/merchant/notifications/{id}/read

Use this operation to reconcile the merchant notification center with user actions in the dashboard.

Alert settings

Alert settings are related but distinct from notification items. They control the merchant's alerting preferences and should be documented with the settings surface.

Documentation note

This page documents the merchant operational notification surface, not generic webhook delivery or public API event subscriptions.