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 | Payload |
|---|---|---|
StatementsReceived | Account statement received. | Show{
"companyId": "guid",
"batchId": "guid",
"accountNumber": "string",
"links": []
} |
SettlementReceived | Receipt of payment. | Show{
"companyId": "guid",
"batchId": "guid",
"links": []
} |
ReceivableReceived | In-payment received. | Show{
"companyId": "guid",
"batchId": "guid",
"links": []
} |
FileReceived | File received. | Show{
"companyId": "guid",
"fileId": "guid",
"agreementId": "guid",
"links": []
} |
PaymentApprovalEnabled | Approval for payment enabled. | Show{
"companyId": "guid",
"bic": "string",
"links": []
} |
PaymentApprovalDisabled | Approval for payment disabled. | Show{
"companyId": "guid",
"bic": "string",
"links": []
} |
PaymentStatusUpdated | Status of payment updated. | Show{
"companyId": "guid",
"batchId": "guid",
"links": []
} |
ServiceActivated | Service activated. | Show{
"companyId": "guid",
"bic": "string",
"links": []
} |
ServiceDeactivated | Service deactivated. | Show{
"companyId": "guid",
"bic": "string",
"links": []
} |
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"
}
]
}
}