Assignment Flow

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

How to use this flowchart

Hover over each step to see the endpoint details and access the full documentation. The three colored tracks show at the same time what happens to the batch, to the assets and which webhooks you can receive — only the statuses subscribed in your webhook configuration arrive.

Legend

Integrating Agent

QI Tech (automatic)

Consultant / Manager

Batch Status

Asset Status

Webhook

Flowchart

1

Batch CreationIntegrating 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 InsertionIntegrating Agent

Inserts the assets into the batch (CCB, duplicata, discounted contract or installment 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 the insertion.

CCB →   Duplicata →   Discounted Contract →   Installment Contract →

3

Document UploadIntegrating Agent

Uploads the documents required for each asset (PDF, P7S or XML in Base64). Duplicatas mercantis do not require documents.

Batch: pending_assets_insertionAsset: pending_eligibility

POST /trade_receivables/.../asset/{asset_external_id}/document

The documents can be uploaded right after the asset is inserted or after the pending_documentation webhook (step 5a).

View full documentation →

4

Close InsertionIntegrating Agent

Signals that all assets have been inserted into the batch. The eligibility analysis starts automatically.

Batch: completed_assets_insertionAsset: pending_eligibility

PUT /trade_receivables/.../assignment/{assignment_external_id}

Send {"assignment_status": "completed_assets_insertion"}. There is no need to wait for the 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: pending_documentation / pre_approved / deniedWebhook: asset_status_change

Asset approved

pre_approved

The asset was approved in eligibility; if the product requires documents, it goes through pending_documentation first.

Asset denied

denied

The asset does not continue 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

Once all assets have been analyzed, QI Tech evaluates the eligibility of the batch as a whole.

Batch: pending_consultant_approval / pending_manager_approval / deniedWebhook: assignment_status_change

Eligible batch

pending_manager_approval

The batch awaits approval by the consultant and/or the manager (step 6). If the configuration provides for automatic approval, it goes straight to asset registration and formalization.

Batch denied

denied

The batch was denied by the fund's eligibility rules, or all assets were denied. Flow ended.

Webhook trade_receivables.assignment_status_change — reports whether the batch was approved or denied in eligibility.

View batch webhook documentation →

6

Consultant and/or Manager ApprovalConsultant / Manager

When the configuration requires manual approval, the consultant and/or the manager approve or deny the batch (through the API or the portal). Once approved, the batch moves on to asset registration and formalization and then to the Assignment Term.

Batch: pending_assets_registry / waiting_assets_to_formalize

PUT /trade_receivables/.../assignment/{assignment_external_id}

Send {"assignment_status": "approved"} or "denied". The final approval does not generate a webhook: use the status in the response. The next batch webhook arrives with the Assignment Term (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 retrieve the document at any time.

Batch: pending_paymentWebhook: assignment_status_change

GET /trade_receivables/.../assignment/{assignment_external_id}/assignment_term_link

GET /trade_receivables/fund_class/{fund_class_key}/assignment_terms

Retrieve the Assignment Term (original and signed) of a batch or list the fund class terms by date. After all parties sign, you receive the webhook with status pending_payment.

View full documentation →

8

Payment to the AssignorQI Tech

The payment is made automatically to the assignor into the disbursement account defined for the batch.

Batch: pending_assets_wallet_inclusionWebhook: assignment_status_change

The total amount is the sum of the total_purchase_value of the assets not denied; in substitution batches, net of the value of the repurchased assets. After the payment, you receive the webhook with status pending_assets_wallet_inclusion.

9

Portfolio InclusionQI Tech

The assets are added to the fund's portfolio. The assignment is complete.

Batch: completedAsset: completedWebhook: assignment_status_change

You receive the final webhook with status completed. From that moment on, the assets are in the fund's portfolio.

View webhook documentation →

---

Webhook Summary

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

#	Webhook type	Status	Moment in the flow	Expected action
1	asset_creation	pending_eligibility	After each asset is inserted (step 2)	None — receipt confirmation.
2	asset_status_change	pending_documentation / pre_approved	Asset approved in eligibility (step 5a)	If pending_documentation, upload the missing documents.
3	asset_status_change	denied	Asset denied in eligibility (step 5a)	None — the asset does not continue.
4	assignment_status_change	pending_consultant_approval / pending_manager_approval	Batch approved in eligibility (step 5b)	Approve or deny, if you are the consultant or the manager.
5	assignment_status_change	denied	Batch denied in eligibility (step 5b)	None — flow ended.
6	assignment_status_change	pending_assignment_term_signature	Assignment Term sent for signature (step 7)	Optional: retrieve the Assignment Term.
7	assignment_status_change	pending_payment	Term signed by all parties (step 7)	None — payment being processed.
8	assignment_status_change	pending_assets_wallet_inclusion	Payment made (step 8)	None — portfolio inclusion being processed.
9	assignment_status_change	completed	Assets added to the portfolio (step 9)	Assignment successfully completed.
—	assignment_status_change	discarded	Fund's accounting closing, for batches not yet paid or denied	None — batch discarded.

Webhook prefix

All webhook types have the trade_receivables. prefix. For example: trade_receivables.asset_creation and trade_receivables.assignment_status_change. For details on the full webhook structure, see Asset Webhooks and Batch Webhooks. The intermediate statuses that do not appear in this table are also there.