Pular para o conteúdo principal

Fluxo de Cessão

Esta página oferece uma visão holística de todo o fluxo de cessão de direitos creditórios, desde a criação do lote até o encarteiramento dos ativos na carteira do fundo. Acompanhe a evolução dos status do lote, dos status dos ativos e dos webhooks recebidos em cada etapa.

Como usar este fluxograma

Passe o mouse sobre cada etapa para ver os detalhes do endpoint e acessar a documentação completa. As três trilhas coloridas mostram simultaneamente o que acontece com o lote, com os ativos e quais webhooks você pode receber — só chegam os status assinados na sua configuração de webhook.

Legenda​

Agente Integrador
QI Tech (automático)
Consultoria / Gestora
Status do Lote
Status do Ativo
Webhook

Fluxograma​

1
Criação do LoteAgente Integrador
Cria um lote de cessão com um identificador único (external_id).
Lote: pending_assets_insertion
POST /trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment
O lote é criado em status pending_assets_insertion, pronto para receber ativos.
Ver documentação completa →
2
Inserção dos AtivosAgente Integrador
Insere os ativos no lote (CCB, duplicata, contrato descontado ou contrato parcelado). Repita para cada ativo.
Lote: pending_assets_insertionAtivo: pending_eligibilityWebhook: asset_creation

POST /trade_receivables/.../assignment/{assignment_external_id}/asset
Cada ativo é criado com status pending_eligibility. Você receberá um webhook trade_receivables.asset_creation confirmando a inserção.
CCB →   Duplicata →   Contrato Descontado →   Contrato Parcelado →

3
Envio do LastroAgente Integrador
Envia o lastro de cada ativo: os documentos que o comprovam (PDF, P7S ou XML em Base64). Duplicatas mercantis não exigem documentos. Não é aqui que entra o Termo de Cessão (etapa 7).
Lote: pending_assets_insertionAtivo: pending_eligibility
POST /trade_receivables/.../asset/{asset_external_id}/document
Os documentos podem ser enviados logo após a inserção do ativo ou depois do webhook pending_documentation (etapa 5a).
Ver documentação completa →
4
Encerrar InserçãoAgente Integrador
Sinaliza que todos os ativos foram inseridos no lote. A análise de elegibilidade será iniciada automaticamente.
Lote: completed_assets_insertionAtivo: pending_eligibility
PUT /trade_receivables/.../assignment/{assignment_external_id}
Envie {"assignment_status": "completed_assets_insertion"}. Não é necessário aguardar os webhooks de elegibilidade individual dos ativos.
Ver documentação completa →
5a
Elegibilidade dos AtivosQI Tech
A QI Tech analisa cada ativo individualmente. Você recebe um webhook por ativo com o resultado.
Lote: completed_assets_insertionAtivo: pending_documentation / pre_approved / deniedWebhook: asset_status_change
Ativo aprovado
pre_approved
O ativo foi aprovado na elegibilidade; se o produto exige documentos, passa por pending_documentation antes.
Ativo reprovado
denied
O ativo não segue adiante no fluxo.
Webhook trade_receivables.asset_status_change — enviado para cada ativo com o resultado da elegibilidade.
Ver documentação de webhooks do ativo →
5b
Elegibilidade do LoteQI Tech
Quando todos os ativos forem analisados, a QI Tech avalia a elegibilidade do lote como um todo.
Lote: pending_consultant_approval / pending_manager_approval / deniedWebhook: assignment_status_change
Lote elegível
pending_manager_approval
O lote aguarda a aprovação da consultoria e/ou da gestora (passo 6). Se a configuração prevê aprovação automática, segue direto para o registro e a formalização dos ativos.
Lote reprovado
denied
O lote foi reprovado pelas regras de elegibilidade do fundo, ou todos os ativos foram reprovados. Fluxo encerrado.
Webhook trade_receivables.assignment_status_change — informa se o lote foi aprovado ou reprovado na elegibilidade.
Ver documentação de webhooks do lote →
6
Aprovação da Consultoria e/ou da GestoraConsultoria / Gestora
Quando a configuração exige aprovação manual, a consultoria e/ou a gestora aprovam ou reprovam o lote (via API ou pelo portal). Aprovado, o lote segue para o registro e a formalização dos ativos e, depois, para o Termo de Cessão.
Lote: pending_assets_registry / waiting_assets_to_formalize
PUT /trade_receivables/.../assignment/{assignment_external_id}
Envie {"assignment_status": "approved"} ou "denied". A aprovação final não gera webhook: use o status da resposta. O próximo webhook do lote chega com o Termo de Cessão (pending_assignment_term_signature).
Ver documentação completa →
7
Termo de Cessão do LoteQI Tech
A QI Tech gera o Termo de Cessão do lote e o encaminha para assinatura. Todas as partes relacionadas precisam assinar o termo para que o fluxo prossiga. O integrador não envia o termo: só o consulta, a partir de pending_assignment_term_signature.
Lote: 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
Consulte o Termo de Cessão (original e assinado) de um lote ou liste os termos da classe de fundo por data. Após todas as partes assinarem, você recebe o webhook com status pending_payment.
Ver documentação completa →
8
Pagamento ao CedenteQI Tech
O pagamento é feito automaticamente ao cedente na conta de desembolso definida para o lote.
Lote: pending_assets_wallet_inclusionWebhook: assignment_status_change
O valor total é a soma dos total_purchase_value dos ativos não reprovados; em lotes de substituição, descontado o valor dos ativos recomprados. Após o pagamento, você recebe o webhook com status pending_assets_wallet_inclusion.
9
EncarteiramentoQI Tech
Os ativos são incluídos na carteira do fundo. A cessão está concluída.
Lote: completedAtivo: completedWebhook: assignment_status_change
Você recebe o webhook final com status completed. A partir desse momento, os ativos se encontram na carteira do fundo.
Ver documentação de webhooks →

Resumo de webhooks​

A tabela abaixo consolida todos os webhooks que o integrador recebe ao longo do fluxo, na ordem cronológica:

#Tipo do webhookStatusMomento no fluxoAção esperada
1asset_creationpending_eligibilityApós inserção de cada ativo (passo 2)Nenhuma — confirmação de recebimento.
2asset_status_changepending_documentation / pre_approvedAtivo aprovado na elegibilidade (passo 5a)Se pending_documentation, enviar o lastro que falta.
3asset_status_changedeniedAtivo reprovado na elegibilidade (passo 5a)Nenhuma — ativo não segue adiante.
4assignment_status_changepending_consultant_approval / pending_manager_approvalLote aprovado na elegibilidade (passo 5b)Aprovar ou reprovar, se você é a consultoria ou a gestora.
5assignment_status_changedeniedLote reprovado na elegibilidade (passo 5b)Nenhuma — fluxo encerrado.
6assignment_status_changepending_assignment_term_signatureTermo de Cessão enviado para assinatura (passo 7)Opcional: baixar o Termo de Cessão do lote.
7assignment_status_changepending_paymentTermo assinado por todas as partes (passo 7)Nenhuma — pagamento em processamento.
8assignment_status_changepending_assets_wallet_inclusionPagamento realizado (passo 8)Nenhuma — encarteiramento em processamento.
9assignment_status_changecompletedAtivos encarteirados (passo 9)Cessão concluída com sucesso.
—assignment_status_changediscardedFechamento contábil do fundo, para lotes ainda não pagos ou reprovadosNenhuma — lote descartado.
Prefixo dos webhooks

Todos os tipos de webhook possuem o prefixo trade_receivables.. Por exemplo: trade_receivables.asset_creation e trade_receivables.assignment_status_change. Para detalhes sobre a estrutura completa dos webhooks, consulte Webhooks do Ativo e Webhooks do Lote. Lá também estão os status intermediários que não aparecem nesta tabela.