Webhooks do Lote de Cessão
Ao longo do fluxo de cessão, o sistema envia webhooks para notificar o parceiro integrador sobre mudanças de status do lote. Todos os webhooks possuem o tipo trade_receivables.assignment_status_change e identificam o lote pelo assignment_external_id fornecido na criação.
Para receber webhooks, é necessário ter uma URL de callback configurada junto à QI Tech. Entre em contato com integracao.dtvm@qitech.com.br para configurar.
Fluxo de status do lote
O diagrama abaixo ilustra as transições de status que geram webhooks ao longo do fluxo:
Estrutura do webhook
Todos os webhooks do lote de cessão seguem a mesma estrutura:
| Campo | Tipo | Descrição |
|---|---|---|
webhook_type | string | Sempre trade_receivables.assignment_status_change. |
webhook_datetime | string | Data e hora do evento no formato ISO 8601. |
data | object | Dados do evento. Veja tabela abaixo. |
Atributos de data
| Campo | Tipo | Descrição |
|---|---|---|
assignment_external_id | string | O external_id do lote informado na criação. |
assignment_new_status | string | Novo status do lote. |
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "STATUS"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Eventos por status
Reprovado na Elegibilidade
Enviado quando o lote é reprovado na análise de elegibilidade. Isso ocorre quando o lote como um todo causa algum desenquadramento do fundo, mesmo que os ativos individuais tenham sido aprovados. O lote ainda pode ser manipulado, porém caso nada aconteça ele será descartado.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "denied"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Pendente Aprovação do Gestor
Enviado quando o lote é aprovado na elegibilidade e está aguardando a decisão do gestor do fundo. O gestor deve aprovar ou reprovar o lote via Aprovação do Gestor ou pelo Portal do Gestor.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_manager_approval"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Pendente Assinatura do Termo
Enviado após a aprovação do gestor, quando o Termo de Cessão foi gerado e encaminhado para assinatura de todas as partes envolvidas. Você pode consultar o documento via Documentos da Cessão.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_assignment_term_signature"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Pendente Pagamento
Enviado após o Termo de Cessão ter sido assinado por todas as partes. O sistema irá realizar o pagamento ao cedente na conta configurada. O valor total é a soma dos total_purchase_value de todos os ativos não descartados do lote.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "pending_payment"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Cessão Completa
Enviado quando todos os ativos do lote foram encarteirados na carteira do fundo. A partir desse momento, os ativos já se encontram dentro do estoque do fundo. Este é o status final de uma cessão bem-sucedida.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "completed"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}
Lote Descartado
Enviado quando o lote é descartado. Isso pode ocorrer por reprovação na elegibilidade, reprovação do gestor, ou por problemas no registro dos ativos. O lote não seguirá adiante no fluxo.
{
"data": {
"assignment_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
"assignment_new_status": "discarded"
},
"webhook_type": "trade_receivables.assignment_status_change",
"webhook_datetime": "2024-04-23T15:08:30Z"
}