Aggregation Link Update

aggregation.link-updated

This event occurs when an aggregation link is updated.

Payload Object

string (UUID)

Event ID.

type

string

Event type. Value is aggregation.link-updated.

createdAt

string (date-time)

Date and time the event occurred.

data

object

Data related to the event.

businessAccountId

string (UUID)

ID of the Business Account.

linkId

string (UUID)

ID of the link.

holderId

string (UUID)

ID of the account holder for the Financial Account.

holderType

string

Type of account holder for the Financial Account.

linkStatus

string, enum values: ACTIVE, REFRESHING, DISABLED

Status of the link.

financialAccountId

string (UUID)

Financial Account ID.

aggregationLinkEventType

string

Link event type.

Sample Payload Object

				
					{
  "id": "626f29e9-6808-4311-bd3c-ba583bb0dc31",
  "type": "aggregation.link-updated",
  "createdAt": "2025-04-10T21:10:53.857Z",
  "data": {
    "businessAccountId": "1bc01b25-0755-45b5-912c-0cecfd9db9bd",
    "linkId": "c84e61c0-9c25-4fc6-9b62-d2f946004f64",
    "holderId": "bdfc2d1c-7b35-4e3c-a526-3d99e39f06d0",
    "holderType": "CUSTOMER",
    "linkStatus": "ACTIVE",
    "financialAccountId": "064602e0-e544-4a1a-bc59-7a65ef84eb01",
    "aggregationLinkEventType": "ACCOUNT_LINKED"
  }
}