2025-01-10: Changes to the bankFeeds.sourceAccount webhook payload
On January 10, 2025, we will update the webhook payloads for the bankFeeds.sourceAccount.connected and bankFeeds.sourceAccount.disconnected event types to align with our new webhook schema definition.
When these webhooks were initially released, they didn't include the top-level schema which provides metadata about the event. The payload now also includes reference company details.
1 | { | 1 | { | ||
2 | - | 2 | + | "eventType": "bankFeeds.sourceAccount.connected", | |
3 | - | 3 | + | "generatedDate": "2022-10-23T00:00:00.000Z", | |
4 | - | 4 | + | "payload": { | |
5 | - | 5 | + | "referenceCompany": { | |
6 | - | "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", | 6 | + | "id": "8a210b68-6988-11ed-a1eb-0242ac120002" |
7 | + | }, | |||
7 | "connectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171", | 8 | "connectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171", | ||
8 | "sourceAccount": { | 9 | "sourceAccount": { | ||
9 | "id": "acc-002", | 10 | "id": "acc-002", | ||
10 | "accountName": "account-081", | 11 | "accountName": "account-081", | ||
11 | "sortCode": "123456", | 12 | "sortCode": "123456", | ||
12 | "accountType": "Credit", | 13 | "accountType": "Credit", | ||
13 | "accountNumber": "12345670", | 14 | "accountNumber": "12345670", | ||
14 | "currency": "GBP", | 15 | "currency": "GBP", | ||
15 | "balance": 99.99, | 16 | "balance": 99.99, | ||
16 | "modifiedDate": "2023-01-09T14:14:14.1057478Z", | 17 | "modifiedDate": "2023-01-09T14:14:14.1057478Z", | ||
17 | "status": "pending" | 18 | "status": "pending" | ||
18 | } | 19 | } | ||
20 | + | } | |||
19 | } | 21 | } |
Action required
If you are currently using bankFeeds.sourceAccount.connected and bankFeeds.sourceAccount.disconnected webhook event types, you will need to update your webhook consumer that listens to these event types to handle the updated schema definition.
Expected impact
If no action is taken to handle the updated schema definition by January 10, 2025, receiving the bankFeeds.sourceAccount.connected and bankFeeds.sourceAccount.disconnected event types to your webhook consumer will result in deserialization errors. This means your application will not process these events correctly.