Pular para o conteúdo principal

Criação de Ativo — Contrato Descontado

Endpoint para inserir um ativo do tipo Contrato Descontado em um lote de cessão. Este tipo de ativo representa uma parcela de um contrato de crédito cujo direito creditório será cedido ao fundo.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiEscrita
Consultoriaconsultant-apiLotes
Cedenteassignor-apiEscrita

URL base de cada host: Ambientes (Hosts).

Onde estou no fluxo?

Este é o 2º passo do fluxo de cessão. Antes, você deve ter criado o lote. Após inserir os ativos, envie os documentos exigidos e encerre a inserção.

Atenção

O campo external_id do direito creditório identifica o ativo dentro do lote e não deve ser confundido com o external_id do lote.

Request​

ENDPOINT
/trade_receivables/fund_class/{fund_class_key}/assignment_configuration/{assignment_configuration_key}/assignment/{assignment_external_id}/asset
MÉTODO
POST
Request Body
{
"asset_type": "discounted_contract",
"total_purchase_value": 1231.21,
"discounted_credit_right": {
"external_id": "mdf27za1-ra5f-46c0-a32f-fb909884dbb2",
"originator_document_number": "22.333.444/0001-81",
"face_value": 1231.21,
"maturity_date": "2025-12-10",
"installment_number": 1,
"borrower": {
"name": "Natália Nascimento",
"document_number": "969.698.790-03",
"person_type": "natural_person",
"email": "natalia.nascimento@yopmail.com",
"address": {
"street": "Gilberto Sabino",
"number": "215",
"neighborhood": "Pinheiros",
"city": "São Paulo",
"postal_code": "05425-020",
"uf": "SP",
"country": "BRA"
},
"phone": {
"area_code": "11",
"number": "36360268"
},
"natural_person": {
"mother_name": "Lívia Santos",
"birthdate": "2001-01-05"
}
},
"contract": {
"number_of_installments": 5,
"total_face_value": 1231.21,
"number": "958431587",
"issue_date": "2023-10-10"
}
}
}

Atributos do body​

CampoTipoObrigatoriedadeDescrição
asset_typestringobrigatórioTipo do ativo. Para contrato descontado, informar discounted_contract.
total_purchase_valuenumberobrigatórioValor total da compra do ativo — efetivamente quanto o cessionário vai pagar. Até 2 casas decimais.
discounted_credit_rightobjectobrigatórioDados do direito creditório. Veja Atributos de discounted_credit_right.

Atributos de discounted_credit_right​

CampoTipoObrigatoriedadeDescrição
external_idstringobrigatórioChave única de identificação deste ativo no sistema do parceiro. Máximo de 50 caracteres.
originator_document_numberstringobrigatórioCPF ou CNPJ formatado (000.000.000-00 ou 00.000.000/0000-00) do originador que viabilizou a operação. Precisa estar cadastrado na QI Tech; caso contrário, devolve TRC000019.
face_valuenumberobrigatórioValor de face. Até 8 casas decimais.
maturity_datestringobrigatórioData de vencimento da parcela no formato YYYY-MM-DD.
installment_numberintegerobrigatórioNúmero da parcela do contrato que este ativo representa. Sem ele, a inserção devolve TRC000077.
borrowerobjectobrigatórioDados do sacado. Consulte os Atributos de borrower na página de Criação de Ativo — CCB.
contractobjectobrigatórioDados do contrato. Veja Atributos de contract. Sem ele, a inserção devolve TRC000075. Não envie o objeto invoice neste tipo de ativo (TRC000076).

Atributos de contract​

CampoTipoObrigatoriedadeDescrição
number_of_installmentsintegerobrigatórioNúmero total de parcelas do contrato.
total_face_valuenumberobrigatórioValor de face total do contrato. Até 2 casas decimais.
numberstringobrigatórioNúmero do contrato. Máximo de 50 caracteres.
issue_datestringobrigatórioData de emissão no formato YYYY-MM-DD.

Response​

STATUS
201
Response Body
{
"asset_key": "41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"external_id": "mdf27za1-ra5f-46c0-a32f-fb909884dbb2",
"status": "pending_eligibility"
}

Atributos da resposta​

CampoTipoDescrição
asset_keystringIdentificador único do ativo gerado pela QI Tech (UUID).
external_idstringA mesma chave externa fornecida no campo external_id do discounted_credit_right.
statusstringStatus inicial do ativo. Sempre retorna pending_eligibility, indicando que o ativo foi inserido e aguarda análise de elegibilidade.

Erros​

StatusCódigoQuando acontece
400QIT000001O request body não segue o formato esperado: campo obrigatório ausente, tipo ou formato inválido. A description aponta o campo.
404TRC000018Não existe lote com esse assignment_external_id nesta configuração de cessão.
400TRC000025O asset_type é diferente do tipo de ativo da configuração de cessão.
400TRC000022O lote não aceita mais ativos: a inserção já foi encerrada. Para incluir mais, reabra o lote.
400TRC000009CPF ou CNPJ inválido em originator_document_number ou no document_number de um sacado pessoa física.
404TRC000019Não há originador cadastrado com o originator_document_number informado. Apesar do título (Originator bond not found), o erro não se refere ao vínculo com a configuração.
400TRC000077installment_number ausente.
400TRC000075Objeto contract ausente.
400TRC000076Objeto invoice enviado num ativo discounted_contract.
409TRC000054Já existe um ativo com esse external_id neste lote.
409TRC100026Já existe um direito creditório com esse external_id para o mesmo cedente na carteira do fundo.
400TRC1000xxA validação financeira do ativo recusou o payload. Exemplo: TRC100017 (409), o fundo não compra ativos vencidos.

O corpo de erro segue o formato abaixo:

{
"title": "Already Exist This External Id",
"description": "Already exist an asset with this External Id and asset_key->41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"translation": "Ja existe um ativo com esse External Id e asset_key->41d6ff41-1dac-4df7-9e50-d15210ec57f3",
"code": "TRC000054"
}

Em caso de erro, reenvie a requisição. Duplicidade (TRC000054) significa que o recurso já existe: consulte-o em vez de recriar, pelo endpoint de consulta de ativo. Mais em Reenvio e duplicidade.

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

Próximos passos​

Após inserir o ativo, o fluxo continua com:

  1. Envio dos documentos — envie a documentação exigida para cada ativo aprovado na elegibilidade.
  2. Encerramento da inserção — sinalize que todos os ativos foram inseridos para que o lote siga para a análise de elegibilidade.