Skip to main content

Assignment Flow

This page provides a holistic view of the entire credit rights assignment flow, from batch creation to asset inclusion in the fund's portfolio. Follow the evolution of batch statuses, asset statuses, and webhooks received at each step.

How to use this flowchart

Hover over each step to see endpoint details and access the full documentation. The three colored tracks show simultaneously what happens to the batch, assets, and which webhooks you will receive.

Legend

Integration Agent
QI Tech (automatic)
Fund Manager
Batch Status
Asset Status
Webhook

Flowchart

1
Batch CreationIntegration Agent
Creates an assignment batch with a unique identifier (external_id).
Batch: pending_assets_insertion
POST /trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment
The batch is created with status pending_assets_insertion, ready to receive assets.
View full documentation →
2
Asset InsertionIntegration Agent
Inserts assets into the batch (CCB, invoice, or discounted contract). Repeat for each asset.
Batch: pending_assets_insertionAsset: pending_eligibilityWebhook: asset_creation

POST /trade_receivables/.../assignment/{assignment_external_id}/asset
Each asset is created with status pending_eligibility. You will receive a trade_receivables.asset_creation webhook confirming insertion.
CCB →   Invoice →   Discounted Contract →

3
Document SubmissionIntegration Agent
Submits required documents for each asset (PDF in Base64). Commercial invoices (duplicatas mercantis) do not require documents.
Batch: pending_assets_insertionAsset: pending_eligibility
POST /trade_receivables/.../asset/{asset_external_id}/document
Send documents after receiving the pending_documentation webhook for the asset (step 5a).
View full documentation →
4
Close InsertionIntegration Agent
Signals that all assets have been inserted in the batch. The eligibility analysis will start automatically.
Batch: completed_assets_insertionAsset: pending_eligibility
PUT /trade_receivables/.../assignment/{assignment_external_id}
Send {"assignment_status": "completed_assets_insertion"}. It is not necessary to wait for individual asset eligibility webhooks.
View full documentation →
5a
Asset EligibilityQI Tech
QI Tech analyzes each asset individually. You receive one webhook per asset with the result.
Batch: completed_assets_insertionAsset: pre_approved / deniedWebhook: asset_status_change
Asset approved
pre_approved
The asset was pre-approved in eligibility.
Asset rejected
denied
The asset does not proceed in the flow.
Webhook trade_receivables.asset_status_change — sent for each asset with the eligibility result.
View asset webhook documentation →
5b
Batch EligibilityQI Tech
When all assets have been analyzed, QI Tech evaluates the eligibility of the batch as a whole.
Batch: pending_manager_approval / deniedWebhook: assignment_status_change
Batch eligible
pending_manager_approval
The batch awaits fund manager approval (step 6).
Batch rejected
denied
The batch causes fund non-compliance. Flow ended.
Webhook trade_receivables.assignment_status_change — reports whether the batch was approved or rejected in eligibility.
View batch webhook documentation →
6
Manager ApprovalFund Manager
The fund manager reviews and approves or rejects the batch (via API or the Manager Portal). If approved, the Assignment Term is generated automatically.
Batch: pending_assignment_term_signatureWebhook: assignment_status_change
PUT /trade_receivables/.../assignment/{assignment_external_id}
Endpoint available for managers only. Send {"assignment_status": "approved"} or "denied". After approval, you receive the webhook with status pending_assignment_term_signature.
View full documentation →
7
Assignment Term SignatureQI Tech
The Assignment Term is generated and sent for signature. All related parties must sign the term for the flow to proceed. The integrator can consult the document at any time.
Batch: pending_paymentWebhook: assignment_status_change
GET /trade_receivables/.../assignment/{assignment_external_id}/assignment_term_link
Consult the Assignment Term (original and signed). After all parties sign, you receive the webhook with status pending_payment.
View full documentation →
8
Payment to AssignorQI Tech
Payment is made automatically to the assignor in the account configured during onboarding.
Batch: pending_assets_wallet_inclusionWebhook: assignment_status_change
The total amount is the sum of total_purchase_value of all non-discarded assets. After payment, you receive the webhook with status pending_assets_wallet_inclusion.
9
Portfolio InclusionQI Tech
Assets are included in the fund's portfolio. The assignment is complete.
Batch: completedAsset: completedWebhook: assignment_status_change
You receive the final webhook with status completed. From this moment, the assets are in the fund's portfolio.
View webhook documentation →

Webhook Summary

The table below consolidates all webhooks the integrator receives throughout the flow, in chronological order:

#Webhook TypeStatusPoint in FlowExpected Action
1asset_creationpending_eligibilityAfter each asset insertion (step 2)None — receipt confirmation.
2asset_status_changepre_approvedAsset approved in eligibility (step 5a)None — asset pre-approved.
3asset_status_changedeniedAsset rejected in eligibility (step 5a)None — asset does not proceed.
4assignment_status_changepending_manager_approvalBatch approved in eligibility (step 5b)Wait for manager approval.
5assignment_status_changedeniedBatch rejected in eligibility (step 5b)None — flow ended.
6assignment_status_changepending_assignment_term_signatureManager approved the batch (step 6)Optional: consult Assignment Term.
7assignment_status_changepending_paymentTerm signed by all parties (step 7)None — payment in processing.
8assignment_status_changepending_assets_wallet_inclusionPayment completed (step 8)None — portfolio inclusion in processing.
9assignment_status_changecompletedAssets included in portfolio (step 9)Assignment completed successfully.
assignment_status_changediscardedAny time (rejection/error)None — batch discarded.
Webhook prefix

All webhook types have the prefix trade_receivables.. For example: trade_receivables.asset_creation and trade_receivables.assignment_status_change. For details on the complete webhook structure, see Asset Webhooks and Batch Webhooks.