# Event Types

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](#hateoas-links) which contains a link for retrieving the resource(s) that triggered the event.

table
thead
tr
th
Event Name
th
Description
th
Payload
tbody
tr
td
code
StatementsReceived
td
Account statement received.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "batchId": "guid",
  "accountNumber": "string",
  "links": []
}
```

tr
td
code
SettlementReceived
td
 Receipt of payment.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "batchId": "guid",
  "links": []
}
```

tr
td
code
ReceivableReceived
td
In-payment received.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "batchId": "guid",
  "links": []
}
```

tr
td
code
FileReceived
td
File received.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "fileId": "guid",
  "agreementId": "guid",
  "links": []
}
```

tr
td
code
PaymentApprovalEnabled
td
Approval for payment enabled.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "bic": "string",
  "links": []
}
```

tr
td
code
PaymentApprovalDisabled
td
Approval for payment disabled.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "bic": "string",
  "links": []
}
```

tr
td
code
PaymentStatusUpdated
td
Status of payment updated.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "batchId": "guid",
  "links": []
}
```

tr
td
code
ServiceActivated
td
Service activated.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "bic": "string",
  "links": []
}
```

tr
td
code
ServiceDeactivated
td
Service deactivated.
td
details
summary
Show
span

```json
{
  "companyId": "guid",
  "bic": "string",
  "links": []
}
```

## HATEOAS Links

All events also return contextual [HATEOAS](https://en.wikipedia.org/wiki/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. |



```json
{
  "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"
      }
    ]
  }
}
```