Statements
This section describes events that will be triggered for account statements
EVENT | DESCRIPTION |
---|---|
banking.statement.generated | A statement has been generated successfully and is available to download or view as json |
Statement Event Example
{
"id": "0196aa83-5a09-7467-b395-a78b87dcfb21",
"event": "banking.statement.generated",
"timestamp": 1746616934396,
"data": {
"id": "0196aa7a-04eb-75a0-9d14-d12484c5c204",
"to": "2025-05-02",
"from": "2025-05-02",
"state": "COMPLETE",
"format": "pdf",
"accountId": "0191dc9a-b113-7e64-8c6f-03b3f26ecfa9",
"created_at": "2025-05-07T11:20:45.548Z",
"updated_at": "2025-05-07T11:22:15.379Z"
}
}
Webhook Payload Structure
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the webhook event. |
event | string | Event type identifier that describes what this webhook represents. |
timestamp | number | Unix epoch timestamp in milliseconds representing when the event was created. |
data | object | Contains the actual statement data, see section below |
Statement Data
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the statement |
to | string | End date of the period covered by the statement |
from | string | Start date of the period covered by the statement |
state | string | Current state of the statement in its lifecycle |
format | string | The file format for the statement e.g pfd, json, xlsx |
accountId | string | Unique identifier of the account to which this statement belong |
created_at | string | Timestamp indicating when the statement was initially created |
updated_at | string | Timestamp indicating when the statement was last updated |
Updated 2 months ago