Criação do Lote de Cessão

Este é o primeiro passo do fluxo de cessão de direitos creditórios. A criação do lote (assignment) reserva um agrupamento onde os ativos que serão cedidos ao fundo serão inseridos nas etapas seguintes.

Disponível em

Perfil	Host	Permissão exigida
Gestora	manager-api	Escrita
Consultoria	consultant-api	Lotes
Cedente	assignor-api	Escrita

URL base de cada host: Ambientes (Hosts).

Pré-requisitos

Antes de criar um lote, você precisa ter em mãos:

• A fund_class_key — chave única do fundo cessionário.
• A assignment_configuration_key — chave única da configuração de cessão, obtida na Homologação de Cedente ou na Listagem de Configurações de Cessão. A configuração precisa estar com status active.

Essas duas chaves compõem o caminho de todos os endpoints de cessão:

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}

Request

ENDPOINT

/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment

MÉTODO

POST

Request Body

{
    "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
    "assignment_date": "2024-04-01"
}

Atributos do body

Campo	Tipo	Obrigatoriedade	Descrição
external_id	string	obrigatório	Identificador do lote no seu sistema, de 1 a 50 caracteres. É único em toda a plataforma, não só no fundo: use um UUID. É por ele que você consulta o lote e que os webhooks identificam o lote.
assignment_date	string	opcional	Data da cessão, no formato YYYY-MM-DD. Não pode ser anterior à data contábil vigente do fundo. Se omitida, vale a data contábil vigente. Com data futura, o lote fica em waiting_assignment_date depois do encerramento da inserção e só entra na esteira nessa data.
payment_type	string	opcional	Forma de pagamento ao cedente: pix ou wire_transfer. Se omitido, vale a forma definida na configuração de cessão.
disbursement	object	opcional	Conta de desembolso específica deste lote, no campo target_account (veja abaixo). Se omitido, a conta é definida na aprovação. Recusado quando o contrato de cessão fixa uma única conta de desembolso.
assignor_discounts	array	opcional	Descontos ao cedente, deduzidos do pagamento da cessão. Só aceito quando a configuração de cessão permite descontos (veja abaixo).
assignment_number	number	opcional	Número do lote. Se omitido, a QI Tech gera um.

Atributos de disbursement.target_account

Campo	Tipo	Obrigatoriedade	Descrição
account_branch	string	obrigatório	Agência, com 4 dígitos.
account_number	string	obrigatório	Número da conta, sem o dígito.
account_digit	string	obrigatório	Dígito da conta (1 caractere).
account_type	string	obrigatório	checking_account ou escrow_account.
financial_institution_ispb	string	obrigatório	ISPB da instituição, com 8 dígitos.
financial_institution_code	string	opcional	Código COMPE da instituição, com 3 dígitos.
owner.document_number	string	obrigatório	CPF ou CNPJ do titular, com pontuação.

Atributos de cada item de assignor_discounts

Campo	Tipo	Obrigatoriedade	Descrição
assignor_discount_type	string	obrigatório	expense_reimbursement (reembolso de despesa) ou others.
total_value	number	obrigatório	Valor do desconto, em reais. Mínimo 0.01.
description	string	obrigatório	Descrição do desconto, de 1 a 500 caracteres.
assignor_discount_key	string	opcional	UUID v4 do desconto. Se omitido, a QI Tech gera um.

Response

STATUS

201

Response Body

{
    "assignment_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
    "external_id": "931e9437-d025-41ab-bb53-6b94e10fd361",
    "status": "pending_assets_insertion"
}

Atributos da resposta

Campo	Tipo	Descrição
assignment_key	string	Identificador único do lote gerado pela QI Tech (UUID).
external_id	string	A mesma chave externa fornecida na requisição.
status	string	Status inicial do lote: pending_assets_insertion, pronto para receber ativos.

Reenvio e duplicidade

Em caso de erro, reenvie a requisição. Duplicidade (TRC000041) significa que o lote já existe: consulte-o pela Recuperação do Lote em vez de recriar. Veja Reenvio e duplicidade.

Erros

Status	Código	Quando acontece
400	TRC000014	A configuração de cessão não está ativa.
400	TRC000083	assignment_date é anterior à data contábil vigente do fundo. Omita o campo ou envie a data contábil vigente.
400	TRC000136	Foram enviados assignor_discounts, mas a configuração de cessão não permite descontos ao cedente.
400	TRC000185	Foi enviado disbursement, mas o contrato de cessão fixa uma única conta de desembolso.
404	TRC000016	A combinação de fund_class_key e assignment_configuration_key não corresponde a nenhuma configuração de cessão.
409	TRC000041	Já existe um lote com esse external_id. Veja Reenvio e duplicidade.
422	TRC000161	A configuração exige registro dos ativos, mas não tem câmara de registro configurada. Contate o time de integração.

Erros de autenticação, permissão e host: veja Erros da API.

Próximos passos

1. Inserção dos ativos — adicione os ativos (CCBs, duplicatas etc.) que serão cedidos ao fundo.
2. Envio dos documentos — envie a documentação exigida para cada ativo.
3. Encerramento da inserção — sinalize que todos os ativos foram inseridos para que o lote siga para a análise de elegibilidade.