Ctrlk
tradevest.ai

v.2.4.0

2026-05-12 - Live

2026-04-29 - Test Environment

Added

Savings Plans API

A new API section for managing recurring savings plans for customers, supporting both digital and traditional assets.

  • Documentation Location: API REFERENCE → Trading → Savings Plans

  • Endpoints:

    • POST /savings-plans — Create a savings plan (asynchronous)

    • GET /savings-plans/{savingPlanId} — Retrieve a savings plan by ID

    • PATCH /savings-plans/{savingPlanId} — Update an existing savings plan

    • DELETE /savings-plans/{savingPlanId} — Delete a savings plan

    • GET /savings-plans — List all savings plans for a customer

  • Purpose: Enables partners to create and manage automated recurring investment plans for customers on both digital asset and traditional asset instruments.

  • Key Request Fields (POST/PATCH):

    • instrumentType — DIGITAL_ASSET or traditional asset type

    • instrumentIdentifier — Asset symbol or ISIN

    • savingsAmount — Recurring investment amount in EUR

    • intervalPeriod — Interval enum: MONTH

    • intervalDay — Day of the month the plan executes

    • liquidityCustomerProductId — Cash product to debit

    • savingsCustomerProductId — Target investment product

Traditional Assets: Ex-Ante Cost Information for Savings Plans

A new ex-ante endpoint provides pre-trade cost disclosure for traditional asset savings plans, required for regulatory compliance.

  • Documentation Location: API REFERENCE → Trading → Traditional Assets

  • Endpoint: POST /traditional/ex-ante/savings-plans

  • Purpose: Allows partners to retrieve ex-ante cost estimates before creating a traditional asset savings plan, covering purchase costs, product costs, sale costs, and total cost projections over the plan timeline.

  • Request Body (ExAnteSavingsPlansCostData):

    • Required: isin, exchangeCode, savingsAmount, intervalPeriod, startDate

    • Optional: endDate

  • Response (ExAnteSavingsPlansCostResult):

    • Includes exAnteId, asset, savingsPlans, purchaseCosts, productCosts, saleCosts, total, timeline, metaInfo

Tokenized Assets: Asset Document Download

Partners can now download regulatory documents (e.g. prospectus) for tokenized assets.

  • Documentation Location: API REFERENCE → Trading → Tokenized Assets

  • Endpoint: GET /wawex/assets/{symbol}/document

  • Purpose: Enables retrieval of asset-level documents such as the prospectus for a tokenized instrument, with language selection support.

  • Query Parameters:

    • language — de (default) or en

    • documentType — prospectus (default)

  • Response: Binary file stream (application/octet-stream)

Changed

Savings Plans: Asset Eligibility Filtering

New query parameters and response fields allow partners to filter and identify assets that are eligible for savings plans.

  • Documentation Location: API REFERENCE → Trading → Digital Assets / Traditional Assets

  • Endpoints:

    • GET /digital-assets — New query parameter: savingsPlan (boolean) — filters results to savings-plan eligible assets only

    • GET /traditional/assets — New query parameter: savingsPlan (boolean) — filters results to savings-plan eligible assets only

  • Model Changes (DigitalAsset):

    • Added: savingsPlan (boolean) — indicates whether the asset is eligible for savings plans

    • Added: savingsPlanMinAmount (number, optional) — minimum investment amount for savings plan eligibility

Transaction History: Tokenized Trading Transactions

The transaction history response now includes a new transaction type for tokenized asset trades.

  • Documentation Location: API REFERENCE → Transaction History

  • Endpoint / Affected Workflows: GET /transaction-history

  • Purpose: Partners can now retrieve full transaction history for tokenized asset (WAWEX) orders, consistent with existing digital and traditional asset transaction types.

  • Response Changes:

    • Added: tokenizedTradingTransaction — new transaction variant containing orderId, symbol, tradeSide, quantity, currency, orderType, orderStatus, execution details, fees, and amounts

Transaction History: Net Amount Field

A new netAmount field is available on trade transactions to communicate the net cash impact on the customer's account.

  • Documentation Location: API REFERENCE → Transaction History

  • Endpoint / Affected Workflows: GET /transaction-history

  • Purpose: Provides partners with the net cash effect on the customer's account after fees and taxes have been applied, reducing the need for client-side calculation.

  • Response Changes:

    • Added: netAmount (number, optional) on DigitalTradingTransaction

    • Added: netAmount (number, optional) on TraditionalTradingTransaction

Corporate Actions: Date Precision and New Status Value

Date fields in corporate action responses now return full datetime values, and a new intermediate status value has been introduced.

  • Documentation Location: API REFERENCE → Trading → Corporate Actions

  • Endpoint / Affected Workflows: GET /corporate-actions and related corporate action responses

  • Changes:

    • Updated: exDate, paymentDate, effectiveDate, recordDate, responseDeadline — format changed from date (YYYY-MM-DD) to date-time (ISO 8601, e.g. 2026-05-01T00:00:00Z) for improved precision

    • Added: PENDING — new value in CorporateActionEventStatusEnum, representing an event that has been announced and is currently in progress but not yet settled

Tokenized Assets: WebSocket Price Subscription — Tokenized Asset Symbol

The WebSocket price subscription payload now supports a dedicated field for tokenized asset symbols.

  • Documentation Location: API REFERENCE → WebSocket Prices

  • Endpoint / Affected Workflows: WebSocket price subscription

  • Purpose: Allows partners to subscribe to live price feeds for tokenized assets (WAWEX instruments) separately from digital assets (crypto).

  • Payload Changes:

    • Added: symbol (string) — tokenized asset trading symbol

    • Changed: cryptoSymbol is no longer a required field (remains available for digital asset subscriptions)

Last updated