TRtreasuryspring
Holdings

Update the maturity action(s) for a holding

Changed on

Updates the maturity action(s) for an existing holding.

Send action to apply a single action to the holding's entire maturity value, or actions to split that value across several actions — for example auto-extending part of an extendable holding and withdrawing the rest. Either form replaces every maturity action currently set on the holding, so send the complete instruction each time. Any part of maturityValue left unallocated by actions becomes a HOLD action.

put/holding/{entity_code}/{holding_uid}/maturity-action

Request

  • Base URL
    https://api.treasuryspring.com/api/v1
  • Auth
    HTTP bearer

Path parameters

entity_codestring required

Entity code

holding_uidstring required

uid of the holding whose maturity action is being modified.

Request body

action'ROLL' | 'SWITCH' | 'HOLD' | 'REDEEM'
indicationUidstring nullable

The uid of indication to switch to (Required if action is set to SWITCH). Only valid alongside action — with actions, set it on the action that switches.

reason'Funds returning shortly' | 'Better terms elsewhere' | 'Receipt of interest payment' | 'Switching FTF product' | 'Treasury Operations changed' | 'Need proceeds'

Example request

{
  "actions": [
    {
      "amount": 5000,
      "indicationUid": "f952ed5df4g84f8gh148f4f8sf6g4"
    }
  ],
  "indicationUid": "f952ed5df4g84f8gh148f4f8sf6g4"
}

Response

Maturity actions

entityCodestring required

Entity Code

holdingUidstring required

Holding uid

Example response

{
  "entityCode": "TEST0001",
  "holdingUid": "16cdb3fe25e743fc9eed4b9742869424",
  "maturityActions": [
    {
      "amount": 5000,
      "currency": "GBP",
      "holdingUid": "74628ebad0f54881b3c76acf146eb3c3",
      "subscriptionUid": "dade0389c66241bd8366b017f1ffe19a",
      "type": "ROLL",
      "uid": "96cd54e5ddfd41b0a77afef15a96660d"
    }
  ]
}

Changes

  • 18fcf12924f8Revision changes
    • breaking

      removed the enum value HOLD of the request property

    • breaking

      removed the enum value REDEEM of the request property

    • breaking

      removed the enum value ROLL of the request property

    • breaking

      removed the enum value SWITCH of the request property

    • breaking

      the request property type changed from string to no type

    • info

      added the new optional request property

    • info

      added subschema #2 to the request property anyOf list

    • info

      the request property became optional