Sign in

v1

latestOpenAPI 3.1.02026-08-043160244.3 KB
Subscriptions

Subscribe to an FTF

Subscribe to an FTF

post/subscribe

Headers

idempotency-keystring required

Idempotency Key used to ensure that the same request is not processed more than once. If the same request is received more than once, the second request will be ignored. Each valid new request must have a different Idempotency Key (It is recommended to use a UUID as the Idempotency Key)

Idempotency Key used to ensure that the same request is not processed more than once. If the same request is received more than once, the second request will be ignored. Each valid new request must have a different Idempotency Key (It is recommended to use a UUID as the Idempotency Key)

Request body

amountnumber required

Subscription amount in the currency of the indication

entityCodestring required

Subscribing entity code

indicationUidstring required

Uid of the indication to subscribe to.

maturityAction'Roll' | 'Hold' | 'Redeem'
sourcestring

Source of funds

subscriptionDatestring date nullable

The date to subscribe to the FTF. A list of possible dates can be found in the subscriptionDates field for the indication. If no date provided, this will default to today.

withdrawal_datestring date nullable

Date to withdraw, applicable only if maturity action is set to REDEEM

Example request

{
  "amount": 1000,
  "entityCode": "TEST0001",
  "indicationUid": "539e30e363b549bf80a0961fd0242809",
  "source": "As per Master Subscription Agreement",
  "subscriptionDate": "2024-01-01",
  "withdrawal_date": "2025-01-01"
}

Response

Subscription details

amountnumber required

Subscription amount

cellCodestring required

Cell code

currencystring required

Subscription currency

cutoffDatetimestring date-time required

Cut-off datetime for this subscription (timezone aware). Last point at which the subscription's maturity action can be changed before TreasurySpring locks it in.

entityCodestring required

Subscribing Entity Code

holdingUidstring nullable

Holding uid

indicationUidstring nullable

Indication uid

maturityActionstring required

Maturity action

maturityDatestring date required

Date the holding will mature

obligorExposureCodestring required

Obligor exposure code

obligorExposureNamestring required

Obligor exposure name

productCodestring required

Product code

releaserEmailstring nullable

Releaser email

signerEmailstring nullable

Signer email

sourcestring required

Source of funds

status'PENDING' | 'ACCEPTED' | 'DECLINED' | 'CANCELLED' | 'EXPIRED' required
subscriptionDatestring date required

The date to subscribe to the indication

uidstring required

Subscription uid

yieldnumber nullable

Yield agreed at subscribe time (annualised APY).

Example response

{
  "amount": 1000,
  "cellCode": "Example-IC",
  "currency": "GBP",
  "cutoffDatetime": "2024-01-01T12:15:00",
  "entityCode": "TEST0001",
  "holdingUid": "6e69e21342a24bbdaf9fe4e8a9995fda",
  "indicationUid": "ef8b318a15b04784ba86c8667727d78b",
  "maturityAction": "Roll",
  "maturityDate": "2025-01-01",
  "obligorExposureCode": "BACR[GC]",
  "obligorExposureName": "Barclays Bank Plc [Gov secured]",
  "productCode": "GBP-BACR[GC]-3M",
  "releaserEmail": "example@treasuryspring.com",
  "signerEmail": "example@treasuryspring.com",
  "source": "As per Master Subscription Agreement",
  "subscriptionDate": "2024-01-01",
  "uid": "8a1f37f521f146dbaa4a333d0bc26158",
  "yield": 5
}