The Open Banking API provides a number of event types that can be subscribed to. All events must be prefixed with ZData.Events.Bank.
Every posted event will contain a data parameter, which contains metadata about the event and a HATEOAS Link which contains a link for retrieving the resource(s) that triggered the event.
| Event Name | Description |
|---|---|
▶StatementsReceived | Account statement received. |
▶SettlementReceived | Receipt of payment. |
▶ReceivableReceived | In-payment received. |
▶FileReceived | File received. |
▶PaymentApprovalEnabled | Approval for payment enabled. |
▶PaymentApprovalDisabled | Approval for payment disabled. |
▶PaymentStatusUpdated | Status of payment updated. |
▶ServiceActivated | Service activated. |
▶ServiceDeactivated | Service deactivated. |
All events also return contextual HATEOAS links in the data object. The links can be used to retrieve the resource that triggered the event.
A link item contains the following properties:
| Property | Description |
|---|---|
Method | The request verb for the link. Example: GET |
Rel | The relative resource path name. |
Version | The API version. |
Href | The URL to the resource. |
{
"data": {
...
"Links": [
{
"Method": "GET",
"Rel": "payments",
"Version": "v3",
"Href": "https://bankservice.zdata.no/api/v3/payments/00000000-0000-0000-0000-000000000000/batches/00000000-0000-0000-0000-000000000000/transactions"
}
]
}
}