Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Products API Reference

Get Products

get

Returns Products available within the context of the role of the access-token provided

Authorizations
cdpapi-Subscription-KeystringOptional
Query parameters
includesstringOptional
Responses
200Success
application/json
get/
GET /products/ HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Accept: */*
200Success
{
  "productItems": [
    {
      "productId": "1",
      "productTermType": "FixedTerm",
      "termLengthUnit": "Month",
      "termLength": 1,
      "noticeLengthUnit": "NoNotice",
      "noticeLength": 0,
      "productIssues": [
        {
          "productIssueNumber": 1,
          "productIssueVersionNumber": 1,
          "isClosedToNewAccounts": false,
          "ratePercent": 2.5,
          "depositPerAccountMinimum": 1000,
          "depositPerAccountMaximum": 10000,
          "aer": 2.9,
          "documents": [
            {
              "documentId": "2",
              "documentVersion": 2,
              "documentType": "FlagstoneTerms",
              "contentTypes": [
                "text/html"
              ],
              "uri": "api.flagstoneim.com/products/6/issue/1/version/1/document/FlagstoneTerms"
            }
          ]
        }
      ],
      "financialInstitution": {
        "financialInstitutionId": "2",
        "financialInstitutionVersion": 1,
        "paymentBatchCutoffTimeUTC": "2023-12-18",
        "isFscsProtected": false,
        "isSharia": false,
        "financialInstitutionName": "Aldmore Bank",
        "financialInstitutionShortName": "ALD",
        "financialInstitutionType": "Bank",
        "ginancialInstitutionGroupId": "2",
        "countryCode": "GBR",
        "documents": []
      },
      "currencyCode": "GBP",
      "interestPaidType": "AtMaturity",
      "interestPaysPlan": "NoPaysPlan",
      "interestPaysFrequency": "Month",
      "interestPaysSpecificDates": [],
      "dateLastUpdatedUTC": "2022-01-02T14:50:09.0000000+00:00"
    },
    {
      "productId": "2",
      "productTermType": "InstantAccess",
      "termLengthUnit": "NoTerm",
      "termLength": 0,
      "noticeLengthUnit": "NoNotice",
      "noticeLength": 0,
      "productIssues": [
        {
          "productIssueNumber": 1,
          "productIssueVersionNumber": 3,
          "isClosedToNewAccounts": false,
          "ratePercent": 0.7,
          "aer": 0.5,
          "depositPerAccountMinimum": 0,
          "depositPerAccountMaximum": 85000,
          "documents": [
            {
              "documentId": "2",
              "documentVersion": 2,
              "documentType": "FlagstoneTerms",
              "contentTypes": [
                "text/html"
              ],
              "uri": "api.flagstoneim.com/products/7/issue/1/version/3/document/FlagstoneTerms"
            }
          ]
        },
        {
          "productIssueNumber": 2,
          "productIssueVersionNumber": 2,
          "isClosedToNewAccounts": true,
          "ratePercent": 0.65,
          "aer": 0.6,
          "depositPerAccountMinimum": 0,
          "depositPerAccountMaximum": 85000,
          "documents": []
        }
      ],
      "financialInstitution": {
        "financialInstitutionId": "3",
        "financialInstitutionVersion": 1,
        "paymentBatchCutoffTimeUTC": "2023-12-18",
        "isFscsProtected": false,
        "isSharia": false,
        "financialInstitutionName": "Investec",
        "financialInstitutionShortName": "INV",
        "financialInstitutionType": "Bank",
        "ginancialInstitutionGroupId": "3",
        "countryCode": "GBR",
        "documents": []
      },
      "currencyCode": "GBP",
      "interestPaidType": "Daily",
      "interestPaysPlan": "NoPaysPlan",
      "interestPaysFrequency": "Daily",
      "interestPaysSpecificDates": [],
      "dateLastUpdatedUTC": "2022-02-02T15:28:01.0000000+00:00"
    }
  ]
}

Get Product

get

Returns the full detail of a Product

Authorizations
cdpapi-Subscription-KeystringOptional
Path parameters
productIdanyRequired

The unique identifier of the Product

Responses
200

The detail of the Product

application/json
productIdstringOptional

Unique identifier for the Product

productTermTypestringOptional

Term type of the Product can be FixedTermDeposit, InstantAccess or Notice

termLengthUnitstringOptional

Term length unit can be Day, Month, Year, NoTerm. (NOTE: NoTerm valid for InstantAccess productTermType only)

termLengthinteger · int32Optional

Term length in the unit of termLengthType. (Note: Only set for FixedTermDeposit productTermType)

noticeLengthUnitstringOptional

Notice length unit can be Day, Month, Year, NoNotice. (NOTE: NoNotice valid for FixedTermDeposit and InstantAccess productTermTypes)

noticeLengthinteger · int32Optional
currencyCodestringOptional

Three-letter code for the Currency of the Product (ISO-4217)

interestPaidTypestringOptional

Interest paid type

interestPaysPlanstringOptional

Interest pays plan

interestPaysFrequencystringOptional

Interest pays frequency

interestPaysSpecificDatesarrayOptional

Interest specific pay days

dateLastUpdatedUTCstringOptional
get/{productId}
GET /products/{productId} HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Accept: */*

{
  "productId": "1",
  "productTermType": "FixedTerm",
  "termLengthUnit": "Month",
  "termLength": 1,
  "noticeLengthUnit": "NoNotice",
  "noticeLength": 0,
  "productIssues": [
    {
      "productIssueNumber": 1,
      "productIssueVersionNumber": 1,
      "isClosedToNewAccounts": false,
      "ratePercent": 2.5,
      "depositPerAccountMinimum": 1000,
      "depositPerAccountMaximum": 10000,
      "aer": 2.9,
      "documents": [
        {
          "documentId": "2",
          "documentVersion": 2,
          "documentType": "FlagstoneTerms",
          "contentTypes": [
            "text/html"
          ],
          "uri": "localhost:5001/products/6/issue/1/version/1/document/FlagstoneTerms"
        }
      ]
    }
  ],
  "financialInstitution": {
    "financialInstitutionId": "2",
    "financialInstitutionVersion": 1,
    "paymentBatchCutoffTimeUTC": "2023-12-18",
    "isFscsProtected": false,
    "isSharia": false,
    "financialInstitutionName": "Aldmore Bank",
    "financialInstitutionShortName": "ALD",
    "financialInstitutionType": "Bank",
    "ginancialInstitutionGroupId": "2",
    "countryCode": "GBR",
    "documents": []
  },
  "currencyCode": "GBP",
  "interestPaidType": "AtMaturity",
  "interestPaysPlan": "NoPaysPlan",
  "interestPaysFrequency": "Daily",
  "interestPaysSpecificDates": [],
  "dateLastUpdatedUTC": "2022-01-02T14:50:09.0000000+00:00"
}

Get Product Summary

get
Authorizations
cdpapi-Subscription-KeystringOptional
Path parameters
productIdanyRequired

The Id of the Product.

issueNumberanyRequired

The Product Issue number.

Query parameters
proposedDepositAmountint · enumOptional

The proposed deposit amount to use for the summary information.

Possible values:
Responses
200Success
application/json
get/{productId}/{issueNumber}/summary
GET /products/{productId}/{issueNumber}/summary HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Accept: */*
200Success
{
  "productId": 11,
  "productIssueNumber": 1,
  "netRate": 0.55,
  "estimatedBalance": 10055,
  "dateOfAccountOpen": "2021-10-18T00:00:00.0000000+00:00",
  "termsAndConditionsUrl": "https://localhost:5001/products/11/issue/1/version/1/document/FlagstoneTerms"
}

Get Product Document

get

Returns the content of the document type for the Product

Authorizations
cdpapi-Subscription-KeystringOptional
Path parameters
productIdstringRequired

The unique identifier of the Product

productIssueNumberintegerRequired

The number of the Issue of the Product

productIssueVersionNumberintegerRequired

A version number of the Product Issue

documentTypestring · enumRequired

The type of Document to return.

Possible values:
Header parameters
Acceptstring · enumOptional

Desired content type of the document to be returned

Default: application/pdfPossible values:
Responses
200

File stream to download the file

application/octet-stream
get/{productId}/issue/{productIssueNumber}/version/{productIssueVersionNumber}/document/{documentType}
GET /products/{productId}/issue/{productIssueNumber}/version/{productIssueVersionNumber}/document/{documentType} HTTP/1.1
Host: api.sandbox.flagstoneim.com
cdpapi-Subscription-Key: YOUR_API_KEY
Accept: */*
PreviousClient API ReferenceNextInstruction Request API Reference

Last updated