For the complete documentation index, see llms.txt. This page is also available as Markdown.
Portfolios
What it is: The Portfolios API provides a view of your clients' savings positions.
It shows all deposit accounts, balances, accrued interest, and pending payment batch items.
This is the primary endpoint for tracking the outcome of instructions and reporting to clients.
How it works: Query the portfolios endpoint with pagination to retrieve all client positions, or use the client-specific endpoint to get portfolios for a single client.
Portfolios are versioned.
Base URL:https://api.sandbox.flagstoneim.com/financial-partners
API Version:2020-04-01
π Endpoints
Method
Path
Description
GET
/portfolios
Get paged portfolios for all clients
GET
/clients/{clientReference}/portfolios
Get portfolios for a specific client
π¦ 1. Get All Portfolios (Paged)
What it is: Returns a paged list of all client portfolios under your financial partner.
How it works: Use PageNumber and PageSize query parameters to paginate through the full portfolio set. Results are sorted by last updated date (descending).
GET /portfolios?PageNumber=1&PageSize=50cdpapi-Subscription-Key:your-api-key-here
Response (200 OK):
Pagination
Parameter
Type
Description
PageNumber
integer
The page to retrieve (1-based)
PageSize
integer
Number of portfolios per page
Pagination Example:
π€ 2. Get Portfolios for a Client
What it is: Returns all portfolios for a specific client (one per currency).
How it works: Supply the client reference in the URL path. Optionally include If-Modified-Since header to check for changes since a given date.
Optional Header:
Header
Description
If-Modified-Since
ISO-8601 datetime - returns 304 Not Modified if unchanged
Response (200 OK):
Status
Meaning
200
Portfolios returned
304
Not modified since the If-Modified-Since date
Note: The client-specific endpoint returns additional interest fields (interestAccruedAmount, interestExpectedAmount) and hypermedia links for related resources. These aren't present in the paged portfolio endpoint.
π Understanding the Portfolio Model
Portfolio
Field
Description
portfolioId
Unique identifier for the portfolio
portfolioVersion
Version number (used for optimistic concurrency)
currencyCode
ISO-4217 currency code (GBP, EUR, USD)
depositAccounts
Array of deposit accounts within this portfolio
Deposit Account
Field
Description
depositAccountId
Unique identifier of the deposit account
productId
The product this account was opened against
dateAccountOpenedUTC
When the account was opened
dateAccountMaturesUTC
Maturity date (for fixed term products)
amount
Current balance
interestAccruedAmount
Interest accrued but not yet paid
interestPaidAmount
Interest already paid out
interestExpectedAmount
Total expected interest over the term
Pending Payment Batch Items
These represent instructions that have been accepted but not yet settled: