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.

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 deve ser único para cada ativo 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": "46.282.154/0001-14",
"face_value": 1231.21,
"maturity_date": "2025-12-10",
"installment_number": 1,
"borrower": {
"name": "Natália Nascimento",
"document_number": "19.845.976/0001-93",
"person_type": "natural_person",
"email": "natália.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 do originador/consultor que viabilizou a operação.
face_valuenumberobrigatórioValor de face. Até 8 casas decimais.
maturity_datestringobrigatórioData de vencimento da parcela no formato YYYY-MM-DD.
installment_numberintegeropcionalNúmero da parcela.
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.

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.

Possíveis erros

STATUS
404
Lote não encontrado

O assignment_external_id informado na URL não corresponde a nenhum lote existente nesta configuração de cessão. Verifique se o identificador está correto.

{
"title": "Assignment not found",
"description": "Assignment not found",
"translation": "Lote não encontrado",
"code": "TRC000018"
}
STATUS
404
Tipo de ativo não existe

O valor informado no campo asset_type não é um tipo válido. Verifique se o tipo está correto (ex: discounted_contract).

{
"title": "Asset type does not exist",
"description": "Asset type 'invalid_asset_type' does not exist",
"translation": "Tipo do ativo 'invalid_asset_type' nao existe",
"code": "TRC000015"
}
STATUS
400
Tipo de ativo incompatível com o lote

O lote foi configurado para receber um tipo de ativo diferente do informado. Cada configuração de cessão aceita apenas um tipo de ativo específico. Verifique a configuração de cessão utilizada.

{
"title": "Invalid asset type configuration",
"description": "This assignment can not receive this asset type: discounted_contract",
"translation": "Esse lote não pode receber esse tipo de ativo: discounted_contract",
"code": "TRC000025"
}
STATUS
400
Lote fechado para inserção

O lote já foi encerrado para inserção de novos ativos. Após o encerramento, não é possível adicionar mais ativos. Caso precise, reabra o lote antes de inserir novos ativos.

{
"title": "Assignment is closed",
"description": "Assignment is closed to insert new assets",
"translation": "Lote esta fechado para inserir novos ativos",
"code": "TRC000022"
}
STATUS
400
External ID duplicado

Já existe um ativo cadastrado com o external_id informado. Cada ativo deve ter um identificador único. Gere um novo external_id e tente novamente.

{
"title": "Already Exist This External Id",
"description": "Already exist an asset with this External Id",
"translation": "Ja existe um ativo com esse External Id",
"code": "TRC000054"
}

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.