EventDelivery

The body of each POST to your webhook URL.

data objectrequired

The event, exactly as GET /event returns it.

eventType stringrequired

The event, exactly as GET /event returns it.

Possible values: [ADJUSTED, CANCELLED, CASH_MOVED, CURRENCY_CONVERTED, EXTENDED, FINALIZED, ISSUED, REDEEMED, SPLIT, SUBSCRIBED]

ADJUSTED

costdecimalrequired

Updated principal amount in the holding's currency.

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

holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

maturityDatestringrequired

Updated maturity date (YYYY-MM-DD).

Example: 2025-01-01

maturityValuedecimalrequired

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

Example: 10250.00

mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319

mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967

obligorExposureCodestringrequired

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

Example: BACR

previousMaturityDatestringrequired

Maturity date (YYYY-MM-DD) before the amendment.

Example: 2024-12-01

previousMaturityValuedecimalrequired

Expected maturity value before the amendment.

Example: 10200.00

previousSubscriptionDatestringrequired

Subscription date (YYYY-MM-DD) before the amendment.

Example: 2023-12-01

subscriptionDatestringrequired

Updated subscription date (YYYY-MM-DD).

Example: 2024-01-01

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

CANCELLED

costdecimalrequired

Principal amount that was invested in the cancelled holding.

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

holdingUidstringrequired

Unique identifier of the cancelled holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

uidstringrequired

Unique identifier for this event record.

Example: 00000000000000000000000000000001

CASH_MOVED

amountdecimalrequired

Signed change to available cash. Positive: a deposit recorded by TreasurySpring, or the cash of a declined or cancelled withdrawal being returned. Negative: a withdrawal request setting the cash aside; no further event is emitted when it is paid out. Maturity proceeds (see REDEEMED) and cash used to fund a subscription (see ISSUED) do not produce this event.

Example: 10000.00

currencystringrequired

Three-letter currency code for the cash movement.

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

holdingUidstring | nullnullable

Unique identifier of the Cash holding whose balance changed. An entity has one Cash holding per cell and currency, so GET /holding/{entity_code}/{holdingUid} gives the cellCode. Always present.

Example: 5f2b9c1e8a7d4e3f9b6a1c0d2e4f6a8b

uidstringrequired

Unique identifier for this event record.

Example: 00000000000000000000000000000001

CURRENCY_CONVERTED

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

fromAmountdecimalrequired

Amount in the source currency before conversion.

Example: 12500.00

fromCurrencystringrequired

Source currency code.

Example: USD

fxRatedecimalrequired

Exchange rate applied in the conversion.

Example: 0.800000

toAmountdecimalrequired

Amount in the target currency after conversion.

Example: 10000.00

toCurrencystringrequired

Target currency code.

Example: GBP

uidstringrequired

Unique identifier for this event record.

Example: 00000000000000000000000000000001

EXTENDED

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

extensionOptionDatestring | nullnullable

The holding's next extension option date (YYYY-MM-DD) after the extension, as GET /holding returns it. Null if none applies. Events recorded before 7 October 2026, including backfilled history, carry previousExtensionOptionDate here instead; read the next option date from GET /holding for those.

Example: 2025-02-15

holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

maturityDatestringrequired

Updated maturity date (YYYY-MM-DD) after the extension.

Example: 2025-06-01

maturityValuedecimalrequired

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

Example: 10250.00

mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319

mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967

obligorExposureCodestringrequired

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

Example: BACR

previousExtensionOptionDatestring | nullnullable

Extension option date (YYYY-MM-DD) before the change. Null if none was previously set.

Example: 2024-11-15

previousMaturityDatestringrequired

Maturity date (YYYY-MM-DD) before the extension.

Example: 2024-12-01

pricePerSharedecimalnullable

Price per share at the start of the new extension period, accrued from the earlier periods' yields. GET /holding/{entity_code}/{holding_uid}/extension returns the same value for this extension. Null on events recorded before this field was added.

Example: 1.0012088981806229

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

FINALIZED

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

finalizedbooleanrequired

Always true — the holding is in its final period.

Example: true

holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

maturityDatestringrequired

Date (YYYY-MM-DD) the holding will mature at the end of its final period.

Example: 2025-01-01

maturityValuedecimalrequired

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

Example: 10250.00

mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319

mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967

obligorExposureCodestringrequired

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

Example: BACR

pricePerSharedecimalnullable

Price per share at the start of the final period. Null on events recorded before this field was added.

Example: 1.0012088981806229

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

ISSUED

costdecimalrequired

Principal amount invested in the holding's currency.

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

ftfTypestring | nullnullable

Fixed or Extendable, as type on GET /holding. Null on events recorded before this field was added.

Example: Fixed

holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

issueDatestringrequired

Date (YYYY-MM-DD) the holding was issued.

Example: 2024-01-01

maturityDatestringrequired

Date (YYYY-MM-DD) the holding is scheduled to mature.

Example: 2025-01-01

maturityValuedecimalrequired

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

Example: 10250.00

mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319

mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967

obligorExposureCodestringrequired

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

Example: BACR

pricePerSharedecimalnullable

Price per share at issue, always 1. Null on events recorded before this field was added.

Example: 1.0

productCodestringrequired

Identifier of the product this holding is in.

Example: GBP-BACR[GC]-3M

subscriptionUidstringrequired

Unique identifier of the subscription.

Example: dade0389c66241bd8366b017f1ffe19a

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

REDEEMED

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

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 being redeemed into fxCurrency, in the holding's currency. The converted amount is reported by the CURRENCY_CONVERTED event. 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

mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319

mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967

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

SPLIT

costdecimalrequired

Remaining principal amount on the original holding after the split.

Example: 5000.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

holdingUidstringrequired

Unique identifier of the original holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

maturityValuedecimalrequired

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

Example: 10250.00

mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319

mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967

obligorExposureCodestringrequired

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

Example: BACR

splitCostdecimalrequired

Principal amount assigned to the new holding created by the split.

Example: 5000.00

splitHoldingUidstringrequired

Unique identifier of the new holding created by the split. The new holding has no SUBSCRIBED or ISSUED event of its own and carries the original holding's subscriptionUid; fetch it with GET /holding/{entity_code}/{splitHoldingUid}.

Example: c660adab8e394383a3f839dd9d66bf9e

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

SUBSCRIBED

costdecimalrequired

Principal amount invested in the holding's currency.

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

ftfTypestring | nullnullable

Fixed or Extendable, as type on GET /holding. Null on events recorded before this field was added.

Example: Fixed

holdingUidstringrequired

Unique identifier of the holding.

Example: 6e69e21342a24bbdaf9fe4e8a9995fda

maturityDatestringrequired

Date (YYYY-MM-DD) the holding is scheduled to mature.

Example: 2025-01-01

maturityValuedecimalrequired

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

Example: 10250.00

mmyA360Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA360F format: mmyA360F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.88681319

mmyA365Fdecimalnullable

The holding's money-market yield at the time of the event, in MMYA365F format: mmyA365F as GET /holding returned it then. Null on events recorded before this field was added.

Example: 3.9407967

obligorExposureCodestringrequired

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

Example: BACR

productCodestringrequired

Identifier of the product this holding is in.

Example: GBP-BACR[GC]-3M

subscriptionDatestringrequired

Date (YYYY-MM-DD) the holding starts, when it is due to be funded and issued. For a rolled holding, the previous holding's maturity date. TreasurySpring can change this and maturityDate without a new event (for example when cash arrives late); the ISSUED event carries the issue date and final maturity date, and GET /holding always has the current dates.

Example: 2024-01-01

subscriptionUidstringrequired

Unique identifier of the subscription. For a rolled or switched holding, this matches the subscriptionUid on the previous holding's ROLL or SWITCH maturity action.

Example: dade0389c66241bd8366b017f1ffe19a

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

typestringrequired

event. followed by the lower-cased eventType.

Example: event.cash_moved

EventDelivery

{
  "data": {
    "cost": "10000.00",
    "currency": "GBP",
    "cursor": "ev1.abc123.xyz789",
    "entityCode": "TEST001",
    "eventType": "SUBSCRIBED",
    "ftfType": "Fixed",
    "holdingUid": "6e69e21342a24bbdaf9fe4e8a9995fda",
    "maturityDate": "2025-01-01",
    "maturityValue": "10250.00",
    "mmyA360F": "3.88681319",
    "mmyA365F": "3.9407967",
    "obligorExposureCode": "BACR",
    "productCode": "GBP-BACR[GC]-3M",
    "subscriptionDate": "2024-01-01",
    "subscriptionUid": "dade0389c66241bd8366b017f1ffe19a",
    "uid": "00000000000000000000000000000001",
    "yield": "4.000000"
  },
  "type": "event.cash_moved"
}