Skip to main content

CashMovedEvent

The entity's available cash in a cell changed: a deposit, a withdrawal request, or a withdrawal returned.

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
eventTypestringrequired
Constant value: CASH_MOVED
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
CashMovedEvent
{
  "amount": "10000.00",
  "currency": "GBP",
  "cursor": "ev1.abc123.xyz789",
  "entityCode": "TEST001",
  "eventType": "CASH_MOVED",
  "holdingUid": "5f2b9c1e8a7d4e3f9b6a1c0d2e4f6a8b",
  "uid": "00000000000000000000000000000001"
}