Skip to main content

FinalizedEvent

A holding was confirmed as closed at maturity.

currencystringrequired

Three-letter currency code for the holding.

Example: GBP
cursorstringrequired

Opaque pagination token for this event. Pass as start_cursor on the next request to retrieve events that occurred after this one.

Example: ev1.abc123.xyz789
entityCodestringrequired

Code identifying the organisation (client) this event belongs to.

Example: TEST001
eventTypestringrequired
Constant value: FINALIZED
finalizedbooleanrequired

Always true — confirms the holding is closed at maturity.

Example: true
holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda
maturityDatestringrequired

Date (YYYY-MM-DD) the holding matured.

Example: 2025-01-01
maturityValuedecimalrequired

Expected or actual maturity value (principal plus interest) in the holding's currency.

Example: 10250.00
obligorExposureCodestringrequired

Code identifying the obligor exposure (counterparty) for this holding.

Example: BACR
uidstringrequired

Unique identifier for this event record.

Example: 00000000000000000000000000000001
yielddecimalrequired

Current yield for the holding at the time of the event (annualised APY).

Example: 4.000000
FinalizedEvent
{
"currency": "GBP",
"cursor": "ev1.abc123.xyz789",
"entityCode": "TEST001",
"eventType": "FINALIZED",
"finalized": true,
"holdingUid": "6e69e21342a24bbdaf9fe4e8a9995fda",
"maturityDate": "2025-01-01",
"maturityValue": "10250.00",
"obligorExposureCode": "BACR",
"uid": "00000000000000000000000000000001",
"yield": "4.000000"
}