跳到主要内容

Configurações e consultas

Consultas que preparam um lote de contratos estruturados: a configuração que define o tipo do lote, a data contábil do fundo, o cadastro do cedente e do originador, a conta que recebe o desembolso e os ativos que uma confissão de dívida pode substituir. Nenhuma delas altera dados.

Disponível em
PerfilHostPermissão exigida
Gestoramanager-apiLeitura
Consultoriaconsultant-apiLer contratos
Cedenteassignor-apiLeitura

URL base de cada host: Ambientes (Hosts).

Configurações de contrato​

Lista as configurações de contrato do fundo. A consultoria vê só as configurações vinculadas a ela.

ENDPOINT
/trade_contract/fund_class/{fund_class_key}/contract_configuration
MÉTODO
GET
Response Body — 200
{
"data": [
{
"contract_configuration_key": "4b0a7d0e-2f4c-4f7b-9a43-6f1c2f0f5c11",
"fund_class_key": "d1c7c5a2-8a55-4bb8-9d0a-3f2a8e1c9b77",
"asset_type": "financing_contract",
"operation_type": "financing_contract",
"requires_assignment_term": true,
"requires_cnab_confirmation": false,
"status": "active",
"consultant_key": null,
"validation_configuration_key": "8f1e2a3b-4c5d-6e7f-8091-a2b3c4d5e6f7",
"payment_type": "pix",
"configuration_data": {}
}
]
}
CampoTipoDescrição
contract_configuration_keystringChave da configuração. Vai no body da criação do lote.
asset_typestringTipo de contrato que os lotes desta configuração aceitam: financing_contract, debt_acknowledgment ou contract.
operation_typestringTipo de operação. Igual ao asset_type.
requires_assignment_termbooleanSe a operação exige termo de cessão assinado antes de entrar na carteira.
requires_cnab_confirmationbooleanSe, depois da assinatura, a QI Tech confere o CNAB da operação antes do desembolso.
statusstringactive ou inactive. Só configuração ativa aceita lote novo.
consultant_keystring ou nullConsultoria vinculada à configuração, se houver.
validation_configuration_keystring ou nullConfiguração da validação do lastro enviado por você.
payment_typestringMeio do desembolso ao cedente: pix ou wire_transfer (TED).
configuration_dataobjectParâmetros da configuração definidos pela QI Tech.

A configuração é criada e alterada pelo time de integração da QI Tech: integracao.dtvm@qitech.com.br.

Fundo​

Devolve o nome e a data contábil do fundo. A data de compra do lote não pode ser anterior a ela.

ENDPOINT
/trade_contract/fund_class/{fund_class_key}
MÉTODO
GET
Response Body — 200
{
"fund_class_key": "d1c7c5a2-8a55-4bb8-9d0a-3f2a8e1c9b77",
"name": "FIDC Exemplo",
"accounting_date": "2026-11-09"
}

Cedente e originador​

Confirmam que o cedente e o originador estão cadastrados nos contratos estruturados. Use antes de criar o lote e de inserir contratos.

ENDPOINT
/trade_contract/fund_class/{fund_class_key}/assignor/{assignor_document_number}
ENDPOINT
/trade_contract/fund_class/{fund_class_key}/originator/{originator_document_number}
MÉTODO
GET
Response Body — 200 (cedente)
{
"assignor_key": "0f6b2c1e-7d3a-4e59-8b1c-2a9d4e6f8a10",
"document_number": "11.222.333/0001-81",
"name": "Cedente Exemplo Ltda"
}

O originador devolve originator_key, document_number e name.

Contas de desembolso do cedente​

Lista as contas ativas do cedente que podem receber o desembolso. A account_key escolhida vai em disbursement.account_key na criação do lote; sem ela, o desembolso vai para a conta padrão (default_account: true).

ENDPOINT
/trade_contract/fund_class/{fund_class_key}/assignor/{assignor_document_number}/disbursement_accounts
MÉTODO
GET
Response Body — 200
{
"accounts": [
{
"account_key": "a3f4b5c6-d7e8-4f90-a1b2-c3d4e5f6a7b8",
"account_branch": "0001",
"account_number": "123456",
"account_digit": "7",
"account_type": "checking_account",
"status": "active",
"financial_institution_code": "341",
"financial_institution_ispb": "60701190",
"default_account": true,
"owner": {
"document_number": "11.222.333/0001-81"
},
"description": "Conta principal"
}
]
}

Ativos que a confissão pode substituir​

Lista os ativos ativos do cedente na carteira do fundo, de um tipo. É daqui que saem o asset_key e o external_id de cada ativo em substituted_assets na inserção de uma confissão de dívida.

ENDPOINT
/trade_contract/fund_class/{fund_class_key}/assignor/{assignor_document_number}/eligible_assets?asset_type=ccb
MÉTODO
GET
ParâmetroTipoPadrãoDescrição
asset_typestringduplicata_mercantilTipo dos ativos: duplicata_mercantil, duplicata_servicos, ccb, contract, financing_contract ou debt_acknowledgment.
Response Body — 200 (trecho)
{
"eligible_assets": {
"data": [
{
"asset_key": "5e2d7c1a-3b4f-4a6e-9c8d-7f1e2a3b4c5d",
"external_id": "CCB-2025-000881",
"asset_type": "ccb",
"status": "active"
}
],
"page": 0,
"limit": 10,
"is_last_page": true
}
}

Cada item traz o ativo completo, no formato da carteira; o trecho mostra os campos que a confissão usa. A resposta traz até 10 ativos. Se o ativo que você procura não aparecer, confirme o external_id e o asset_key pela consulta de ativos da cessão.

Erros​

StatusCódigoQuando acontece
404TRC000001Não existe fundo com essa fund_class_key.
404TRC000003O cedente não está cadastrado nos contratos estruturados.
404TRC000058O originador não está cadastrado.
404TRC000062O cedente não tem cadastro de contas.
403QIT000004O cedente da integração não tem acesso a este recurso.
403QIT000005A gestora da integração não é a gestora do fundo.
403QIT000008A consultoria não tem configuração de contrato neste fundo.

Erros de autenticação e de permissão da integração: Erros da API.