Subscription
Subscription schema.
amountnumberrequired
Subscription amount
Example:
1000cellCodestringrequired
Cell code
Example:
Example-ICcurrencystringrequired
Subscription currency
Example:
GBPcutoffDatetimedate-timerequired
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.
Example:
2024-01-01T12:15:00entityCodestringrequired
Subscribing Entity Code
Example:
TEST0001holdingUidstring | nullnullable
Holding uid
Example:
6e69e21342a24bbdaf9fe4e8a9995fdaindicationUidstring | nullnullable
Indication uid
Example:
ef8b318a15b04784ba86c8667727d78bmaturityActionstringrequired
Maturity action
Example:
RollmaturityDatedaterequired
Date the holding will mature
Example:
2025-01-01obligorExposureCodestringrequired
Obligor exposure code
Example:
BACR[GC]obligorExposureNamestringrequired
Obligor exposure name
Example:
Barclays Bank Plc [Gov secured]productCodestringrequired
Product code
Example:
GBP-BACR[GC]-3MreleaserEmailstring | nullnullable
Releaser email
Example:
example@treasuryspring.comsignerEmailstring | nullnullable
Signer email
Example:
example@treasuryspring.comsourcestringrequired
Source of funds
Example:
As per Master Subscription AgreementstatusSubscriptionStatusEnumrequired
Status of the subscription
Possible values: [PENDING, ACCEPTED, DECLINED, CANCELLED, EXPIRED]
Example:
PENDINGsubscriptionDatedaterequired
The date to subscribe to the indication
Example:
2024-01-01uidstringrequired
Subscription uid
Example:
8a1f37f521f146dbaa4a333d0bc26158yieldnumber | nullnullable
Yield agreed at subscribe time (annualised APY).
Example:
5Subscription
{
"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",
"status": "PENDING",
"subscriptionDate": "2024-01-01",
"uid": "8a1f37f521f146dbaa4a333d0bc26158",
"yield": 5
}