Statements

This section describes events that will be triggered for account statements

EVENTDESCRIPTION
banking.statement.generatedA 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

FieldTypeDescription
idstringUnique identifier for the webhook event.
eventstringEvent type identifier that describes what this webhook represents.
timestampnumberUnix epoch timestamp in milliseconds representing when the event was created.
dataobjectContains the actual statement data, see section below

Statement Data

FieldTypeDescription
idstringUnique identifier for the statement
tostringEnd date of the period covered by the statement
fromstringStart date of the period covered by the statement
statestringCurrent state of the statement in its lifecycle
formatstringThe file format for the statement e.g pfd, json, xlsx
accountIdstringUnique identifier of the account to which this statement belong
created_atstringTimestamp indicating when the statement was initially created
updated_atstringTimestamp indicating when the statement was last updated