Assignment Batch Webhooks
Throughout the assignment flow, the system sends webhooks to notify the integrating partner about batch status changes. All webhooks have the type trade_receivables.assignment_status_change and identify the batch by the assignment_external_id provided at creation.
To receive webhooks, you must have a callback URL configured with QI Tech. Contact integracao.dtvm@qitech.com.br to set up.
Batch status flow
The diagram below illustrates the status transitions that generate webhooks throughout the flow:
Webhook structure
All assignment batch webhooks share the same structure:
| Field | Type | Description |
|---|---|---|
webhook_type | string | Always trade_receivables.assignment_status_change. |
webhook_datetime | string | Event date and time in ISO 8601 format. |
data | object | Event data. See table below. |
data attributes
| Field | Type | Description |
|---|---|---|
assignment_external_id | string | The external_id of the batch provided at creation. |
assignment_new_status | string | New batch status. |
fund_class_key | string | Identifier of the fund class associated with the batch. |
signed_term_url | string | URL to download the signed Assignment Term. Present only in the pending_payment webhook when the term was signed digitally. |
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "STATUS",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Events by status
Batch Created — Awaiting Asset Insertion
Sent when a new assignment batch is successfully created and is ready to receive assets. This is the first webhook in the batch lifecycle. The assignor can insert assets while the batch is in this status.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_assets_insertion",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Asset Insertion Completed
Sent when asset insertion is closed by the assignor. From this point, no more assets can be added to the batch, which automatically advances to the eligibility analysis.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "completed_assets_insertion",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Under Eligibility Analysis
Sent when the batch starts the eligibility analysis process. All assets are analyzed individually, and the aggregate result determines the batch approval or denial.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_eligibility",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Pending Consultant Approval
Sent when the batch passes eligibility analysis and is awaiting the consultant's decision. This status occurs when the configured approval flow requires prior consultant approval before the manager. The consultant can approve or deny the batch via the Consultant Portal.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_consultant_approval",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Pending Manager Approval
Sent when the batch is approved in eligibility (and by the consultant, when applicable) and is awaiting the fund manager's decision. The manager must approve or deny the batch via Manager Approval or the Manager Portal.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_manager_approval",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Awaiting Asset Formalization
Sent when the manager approves the batch and the system awaits the completion of formalization (registration) of all approved assets. The batch remains in this status until all assets complete the registration process.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "waiting_assets_to_formalize",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Awaiting Assignment Term Generation
Sent when all assets have been formalized and the system is generating the Assignment Term. The batch awaits completion of document generation before submitting it for signature.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_assignment_term",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Pending Term Signature
Sent after manager approval, when the Assignment Term has been generated and submitted for signature by all involved parties. You can retrieve the document via Assignment Documents.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_assignment_term_signature",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Pending Payment
Sent after the Assignment Term has been signed by all parties. The system will pay the assignor the total amount of the assignment to the configured account. The total amount is the sum of all total_purchase_value of non-discarded assets in the batch.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_payment",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Awaiting Asset Portfolio Inclusion
Sent after payment to the assignor is confirmed, when assets are being added to the fund's portfolio. The system processes the inclusion of assets into the fund's inventory.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_assets_wallet_inclusion",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Assignment Completed
Sent when all assets in the batch have been successfully added to the fund's portfolio. From this point on, the assets are within the fund's inventory. This is the final status of a successful assignment.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "completed",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Denied in Eligibility
Sent when the batch is denied in eligibility analysis or by the fund manager/consultant. The batch can still be manipulated, but if no action is taken it will be discarded.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "denied",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Batch Discarded
Sent when the batch is discarded. This can occur due to eligibility denial, manager denial, or issues in asset registration. The batch will not advance further in the flow.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "discarded",
"fund_class_key": "b7d3e2a1-4c5f-4e8b-9d1a-2f3c4e5a6b7c"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}