Skip to content
Last updated

Overview

The Banking API delivers real-time webhook notifications when resources change. To start receiving events, follow the Events quickstart guide.

Event format

Event Format

See the Event format for more information about the event format.

Events are delivered through the Aritma Events API using the CloudEvents specification. Each event has a standard envelope with the event-specific payload in the data field:

{
  "id": "{guid}",
  "source": "{subscriptionId}",
  "type": "{eventType}",
  "data": { ... },
  "time": "2026-02-03T10:59:15.2395239+00:00",
  "specversion": "1.0",
  "subject": "/subscriptions/{subscriptionId}/resource-groups/{resourceGroup}/providers/aritma.openbanking/accounts/{accountId}",
  "tid": "{tenantId}"
}
Next step

See the Event Payloads reference for data schemas for every banking event type.