Credit Rights Assignment
This section documents the APIs that enable the Credit Rights Assignment process for Investment Funds administered by QI DTVM. The flow covers everything from assignment batch creation to asset inclusion in the fund's portfolio.
For an in-depth understanding of the business rules and product, see the Credit Rights Assignment Manual. We recommend reading it alongside the routes provided here.
- To access these services, contact integracao.dtvm@qitech.com.br to enable access to the Sandbox and Production environments.
- You will need the
fund_class_key(fund key) and theassignment_configuration_key(assignment configuration key), obtained during Assignor Onboarding. - To query available assignment configurations, use the Assignment Configuration Listing endpoint.
How to submit the assignment
There are two paths, with the same end result. Choose one per batch — you cannot mix the two in the same batch.
| Path | How it works | Where |
|---|---|---|
| Through the API, asset by asset | Batch creation, one request per asset, and closing the insertion. This is the flow detailed in this section | Integration API |
| By file | A single file with every asset in the batch: CNAB 444 for duplicatas, CT-e, checks and promissory notes, or CSV for CCB, attorney fees and installment contracts | Manager/consultant portal; manager API |
For duplicatas the format is CNAB 444; CSV is accepted for credit operations (CCB), attorney fees and installment contracts. See Assignment by File, the CNAB 444 Layout — Assignment and the CSV Layout — Installment Contracts, with ready-to-download examples.
Assignment Flow
The diagram below shows the main path, the branches and the resulting status of each step. Hover a node to see the endpoint and click to open its documentation.
Container for all assets that will be assigned to the fund, identified by a unique external_id.
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignmentOne request per asset, with its operation information, installments and drawee data.
.../assignment/{assignment_external_id}/assetThe asset only proceeds in the pipeline after every document required by the product has been submitted.
.../asset/{asset_external_id}/documentSignals that all assets have been inserted and releases the batch for the eligibility analysis.
.../assignment/{assignment_external_id}Each asset is analysed individually and then the batch as a whole. Rejected assets do not stay in the batch.
View documentation →The asset or the batch failed eligibility, or the fund manager rejected the batch. Flow terminated.
A manual step only if the assignment configuration requires it. Otherwise the approval is automatic and no action is needed.
.../assignment/{assignment_external_id}Once the batch is approved, the Assignment Term is generated and signed by all parties.
View documentation →The assignment amount is transferred to the assignor.
View documentation →The assets enter the fund's portfolio and the batch cycle is closed.
View documentation →For every status transition, the webhook payloads and the exception paths, see the Assignment Flow.
Step by Step
1. Batch Creation
Create an assignment batch with a unique identifier (external_id). The batch is the container for all assets that will be assigned to the fund.
Access batch creation documentation
2. Asset Insertion
Add assets (CCBs, duplicatas, installment contracts, etc.) to the created batch. Each asset must be inserted individually with its operation information, installments and drawee data.
Access asset insertion documentation
3. Document Submission
For each asset inserted, send the documents required by the product (contract, invoice, etc.). The asset only proceeds in the pipeline after all required documents have been submitted.
Access document submission documentation
4. Insertion Closure
Signal that all assets have been inserted in the batch. The system will wait for individual analysis of each asset before proceeding with the eligibility of the batch as a whole.
5. Approval
After the batch eligibility is approved, the batch moves on to approval. Depending on the assignment configuration, this step is either manual — the consultant and/or the fund manager review and approve or reject the batch, and the batch stays in pending_consultant_approval / pending_manager_approval until the decision is made — or automatic, with no action from the integrator. If approved, the Assignment Term will be generated automatically.
6. Signature, Payment, and Portfolio Inclusion
The final steps are automated: the Assignment Term is signed by all parties, payment is made to the assignor, and assets are included in the fund's portfolio. Track progress through batch webhooks.
Substitution batches
The substitution flow follows the same steps as the assignment flow, with one extra step: inserting, in the same batch, the assets that will be repurchased by the assignor — Addition of Assets to be Repurchased. Repurchases and new assets can be inserted in any order while the batch is open; to close the insertion, the batch needs at least one repurchase asset, and the value of the new assets cannot be lower than that of the repurchased ones.