Asset Settlement
This section documents the APIs that enable the Asset Settlement process for Investment Funds administered by QI CTVM. Through these APIs, it is possible to record installment payments, amortizations, repurchases, and other settlement events for assets in the fund's portfolio.
The asset settlement described in this section applies exclusively to credit rights (CCBs, invoices, contracts, etc.) already included in the fund's portfolio. Treasury Bills, Debentures, and other fixed-income assets do not apply to this flow.
- To access these services, contact integracao.dtvm@qitech.com.br to enable access to the Sandbox (Staging) and Production environments.
- You will need the
fund_class_key(fund key), which is part of the base URL for all endpoints in this API:
/settlement/fund_class/{fund_class_key}
Settlement Flow
The diagram below illustrates the steps in the flow:
Step by Step
1. Payment Batch Creation
Create a payment batch with a unique identifier (external_id). The batch is the container for all settlements that will be processed together.
Access payment batch creation documentation
2. Settlement Insertion
Add settlements to the created batch. Each settlement must be inserted individually, specifying the asset type, amount, settlement type, and required identifiers.
Access settlement insertion documentation
3. Batch Closure
After inserting all settlements, close the batch to start internal processing. Cash reconciliation and portfolio update will be performed automatically.
Access batch closure documentation
4. Tracking via Webhooks
Track progress through webhooks:
- Payment batch webhooks — notifications about batch status.
- Settlement webhooks — individual status notifications for each settlement.
Cash reconciliation and portfolio update are performed automatically by the API after batch closure.