All notable changes to this project will be documented in this file. This does not include changes to descriptions and guides.
- Closing account status: New
closingstatus on account — account is being closed; new orders, payments and withdrawals are not accepted
- Cut-off dates on fund:
cutOffDateSub/cutOffDateRednow also computed for daily-traded funds (next bank day whose cut-off time has not passed); null only when not computable
- Transfer ref type: New
transferrefTypeon cash and fund transactions, referencing atransferobject - New journey result types:
updateAllocationPlan,updateSavingsPlan,signSubmission,createLegalEntityAccount,kycRenewaldocumentation is updated.
- Cut-off dates on fund:
cutOffDateSubandcutOffDateRed— next subscription/redemption cut-off dates for non-daily-traded funds, computed from the trading calendar; null for daily-traded funds - Trading fields on fund:
isRaif,cutOffTime,subscriptionSettlementDays,redemptionSettlementDaysnow documented on the fund object
- Add performance fields
dayResultcumulativeReturn - Expose performance aggregated by owner and client
- WebSocket overlap-reconnect support: data events (
.create,.update,.delete) now carry aneventId— an opaque UUID, deterministic across server instances — for deduplication when running parallel connections during reconnect hello.instanceId: identifies the server instance handling the connection; a different value on reconnect indicates routing to a different instanceserver_closingevent: heads-up sent ~2 seconds before a graceful server-side close (e.g. during a deploy), giving partners a window to open a parallel connection and switch over
- Connection lifetime: documented the ~1h upper bound enforced by the upstream load balancer; partners should expect a clean close at
connectTime + 3600sand reconnect
- List transfers:
GET /v2/partner/client/{clientId}/account/{accountId}/transfer— list all 3rd-party transfer instructions for an account, including custodian, external reference, status, and timestamps - Transfer in create account journey:
transferfield oncreateAccountjourney now supports configuring 3rd-party transfers into a newly created account, withenforce(required/optional) and a list of custodians with account numbers
- Order type discriminator: Added discriminator on
orderTypefor improved schema tooling support
- Redemption transfer order:
POST /v2/partner/client/{clientId}/order/redemptionTransfer— sell fund units and transfer the proceeds to another internal account belonging to the same client and owner
- Account category on account:
categoryfield (pro/retail) now included in the account response object - Cash transaction refTypes: New text types:
client_fee,correction,gift,compensations,inheritance,dividend,donation,endowment_101,partner_fee,fondo_fee,insurance_tax,insurance_fee,riskpremia_fee - Fund transaction refTypes: New
textandcorrectionfund transaction ref types
- Scope max length: Journey
scopefield max length increased from 500 to 768 characters - Payment account name:
namefield on payment account is now nullable - Callback URL:
callbackUrlmust use HTTPS in production
- Delete savings plan:
DELETE /v2/partner/client/{clientId}/account/{accountId}/savingsplan - Update savings plan journey: New
updateSavingsPlanjourney type for creating or updating savings plans - Update allocation plan instruments:
updateAllocationPlanjourney now supports optionalallocationPlan.instrumentsto replace existing allocations - Optional payment account:
updateAllocationPlanjourneypaymentAccountis now optional — uses existing payment account if not provided - Account withdrawal limit:
GET /v2/partner/client/{clientId}/account/{accountId}/withdrawal/limit
- OpenAPI version: Upgraded from OpenAPI 3.0.3 to 3.1.2.
- Order base: Removed conditional
if/thenvalidation foramount(subscription) andunits(redemption) for improved readability.
- Security guidance: Added trust model section to authentication docs, clarifying partner responsibility for end-user identity verification.
- executorRef: Clarified that executorRef is the executor's SSN, validated against the account owner on write operations.
- Savings plan instruments: Allow specifying available instruments when creating a savings plan journey. Defaults to all instruments in the client universe.
- Account value: Added endpoint for fetching account market value.
- Performance: Added endpoint for fetching account performance data.
- Legal entity support: Support legal entity onboarding. Including depot and insurance accounts.
- Legal entity owner type: Add new ownerType field to account.owner, and new
legal_entityownerType. - Legal entity orders: Support buy, sell orders for legal entity accounts.
- Legal entity kycStatus: Expose kycStatus for legal entities.
- Autogiro mandate status: Expose autogiro mandate status on the bankAccount object.
- Order clientId: Add clientId to order response
- Account category: Allow setting account category (retail/pro) when creating accounts.
- Extended client: Add permission fields to client object. Allowing api-users to observe their permissions.
- Client displayName: Allow api-users to patch the client displayName.
- Error messages: Improved validation error messages, returning only relevant errors.
- Allocation examples: Fixed incorrect field references in instrument allocation examples.
- IP validation: Enforce IP allowlist validation for partner API access in production.
- Block account deletion: Prevent account deletion when pending payment instructions exist.
- Power of attorney agreements: Added endpoint for generating power of attorney agreement PDFs.
- Add bank account journey: Added support for adding bank accounts via Tink.
- Partner IP validation: Validate partner IP.
- Agreements: Added endpoints for fetching the agreements attached to an account. Including PDF generation.
- KYC status: Expose KYC validation status on accounts.
- Allocation plans: Added endpoints for managing allocation plans on accounts.