RedeemedEvent

A holding was redeemed at maturity and proceeds were returned to the client.

costdecimalrequired

Principal amount that was invested.

Example: 10000.00

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: REDEEMED

fxCurrencystring | nullnullable

Currency in which the redemption proceeds were paid out, when this differs from the holding's currency (FX redemption). Null for standard same-currency redemptions.

Example: USD

fxValuedecimalnullable

Amount paid out in fxCurrency. Null for standard same-currency redemptions.

Example: 12500.00

holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

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

RedeemedEvent

{
  "cost": "10000.00",
  "currency": "GBP",
  "cursor": "ev1.abc123.xyz789",
  "entityCode": "TEST001",
  "eventType": "REDEEMED",
  "fxCurrency": "USD",
  "fxValue": "12500.00",
  "holdingUid": "6e69e21342a24bbdaf9fe4e8a9995fda",
  "maturityValue": "10250.00",
  "obligorExposureCode": "BACR",
  "uid": "00000000000000000000000000000001",
  "yield": "4.000000"
}