Sign in

v1

latestOpenAPI 3.1.02026-08-043160244.3 KB
Subscriptions

Validate a prospective subscription

Validate a prospective subscription without committing to it.

Confirms the indication is still available to this entity on the chosen subscription date and that the amount is within the indication's permitted limits, returning the matching indication (including its current pricing). Use this as a pre-flight check before calling /subscribe. A 4xx response indicates the prospective subscription would be rejected.

post/validate

Request body

amountnumber required

Proposed subscription amount in the currency of the indication

entityCodestring required

Subscribing entity code

indicationUidstring required

Uid of the indication to validate against.

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.

Example request

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

Response

The matching indication if the prospective subscription is valid

calendarsstring[] required

List of calendars followed by product

cellCodestring required

Cell Code

createdstring date-time

Indication creation date (timezone aware, London time).

currencystring required

FTF currency

cutoffTimestring time required

Time of day at which subscription cut-off occurs for this product, expressed as a naive wall-clock time in London local time (Europe/London). It is the same for every subscriptionDate. Because it carries no date, it has no UTC offset (a wall-clock time maps to a different UTC instant under GMT vs BST); to obtain the timezone-aware cut-off instant, combine it with the chosen subscriptionDate in the Europe/London timezone.

enabledboolean required

Controls if the indication is enabled or set to notify me

enforceMaximumboolean required

Enforce maximum investment amount (if not enforced any subscription above maximum is subject to review)

enforceMinimumboolean required

Enforce minimum investment amount (if not enforced any subscription below minimum is subject to review)

expirystring date-time

Indication deprecated after expiring, rates subject to change (timezone aware, London time).

extensionDaysinteger nullable

Extension frequency (in days) (extendables only)

finalDaysinteger nullable

Final period (in days) (extendables only)

indicativeFinalYieldnumber nullable

Indicative final period yield, annualised APY (extendables only).

indicativeYieldnumber required

Indicative yield (annualised APY).

issueDatestring date required

Issue date of the FTF

maturityDatestring date required

Maturity date of the FTF

maximumnumber required

Maximum Investment amount (in Millions)

minExtensionsinteger nullable

Minimum extensions to remove dropdown rate (extendables only)

minimumnumber nullable

Minimum investment amount (in Millions)

nbPenaltyExtensionsinteger nullable

Minimum extensions to remove penalty spread (extendables only)

obligorExposureCodestring required

Obligor Exposure Code

obligorExposureNamestring required

Obligor Exposure Name

optionDatestring date nullable

Extension option date (extendables only)

productCodestring nullable

Product Code

restrictedboolean required

Controls if the indication is restricted for a particular entity

sectorstring nullable

Product Sector

subscriptionDatesstring[] required

List of subscription dates

termstring required

The product term

typestring required

FTF type

uidstring required

Indication uid

Example response

{
  "calendars": [
    "TreasurySpring",
    "United Kingdom"
  ],
  "cellCode": "Example-IC",
  "created": "2024-01-01T00:00:00",
  "currency": "GBP",
  "cutoffTime": "12:15:00",
  "enabled": true,
  "enforceMaximum": true,
  "enforceMinimum": true,
  "expiry": "2025-01-01T00:00:00",
  "extensionDays": 7,
  "finalDays": 45,
  "indicativeFinalYield": 5.5,
  "indicativeYield": 5.5,
  "issueDate": "2024-01-01",
  "maturityDate": "2025-01-01",
  "maximum": 100,
  "minExtensions": 7,
  "minimum": 10,
  "nbPenaltyExtensions": 7,
  "obligorExposureCode": "BACR",
  "obligorExposureName": "Barclays Bank Plc [Gov secured]",
  "optionDate": "2025-01-01",
  "productCode": "GBP-BACR[GC]-3M",
  "sector": "Financial",
  "subscriptionDates": [
    "2024-01-01"
  ],
  "term": "3m",
  "type": "Fixed",
  "uid": "8ca8f50d3ef44a43962998a5533f0cfa"
}