跳到主要内容

Criação do lote de contratos

Abre um lote de contratos estruturados. O lote nasce vazio, em pending_assets_insertion, e recebe os contratos em seguida, um por chamada.

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

URL base de cada host: Ambientes (Hosts).

Onde estou no fluxo?

Este é o 1º passo. Antes, consulte a configuração de contrato e, no contrato de financiamento, a conta de desembolso em Configurações e consultas. Depois, insira os contratos.

Request​

ENDPOINT
/trade_contract/fund_class/{fund_class_key}/assignment
MÉTODO
POST
Request Body — contrato de financiamento
{
"external_id": "FIN-2026-000147",
"asset_type": "financing_contract",
"contract_configuration_key": "4b0a7d0e-2f4c-4f7b-9a43-6f1c2f0f5c11",
"assignor_document_number": "11.222.333/0001-81",
"assignment_number": "147/2026",
"purchase_date": "2026-11-09",
"disbursement": {
"amount": 95000.00,
"account_key": "a3f4b5c6-d7e8-4f90-a1b2-c3d4e5f6a7b8"
}
}
Request Body — confissão de dívida
{
"external_id": "CONF-2026-000032",
"asset_type": "debt_acknowledgment",
"contract_configuration_key": "7c2e9b14-5a3d-4f61-8e27-1b9d0c4a6e83",
"assignor_document_number": "11.222.333/0001-81"
}

Atributos do body​

CampoTipoObrigatoriedadeDescrição
external_idstringobrigatórioIdentificador do lote no seu sistema, 1 a 50 caracteres. Único no fundo (TRC000007).
asset_typestringobrigatóriofinancing_contract, debt_acknowledgment ou contract. Precisa ser o tipo da configuração (TRC000006).
contract_configuration_keystringobrigatórioChave da configuração de contrato, 36 caracteres. Precisa ser do fundo e estar ativa.
assignor_document_numberstringobrigatórioCPF ou CNPJ do cedente, 11 a 18 caracteres. Precisa estar cadastrado.
assignment_numberstringopcionalNúmero do lote para os documentos da operação, até 50 caracteres.
purchase_datestringopcionalData de compra, em YYYY-MM-DD. Não pode ser anterior à data contábil do fundo (TRC000046). Sem ela, vale a data contábil do fundo.
disbursementobjectcondicionalPagamento ao cedente. Obrigatório no contrato de financiamento (TRC000008), proibido na confissão de dívida (TRC000009) e opcional no contrato.

Atributos de disbursement​

CampoTipoObrigatoriedadeDescrição
amountnumberobrigatórioValor pago ao cedente, maior que zero.
account_keystringopcionalConta do cedente que recebe o valor, das contas de desembolso. Sem ela, vale a conta padrão do cedente.

Campos fora desta lista são recusados com QIT000001. Os contratos não vão neste body: eles entram depois, um por chamada.

Response​

STATUS
201
Response Body
{
"assignment_key": "9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d",
"external_id": "FIN-2026-000147",
"status": "pending_assets_insertion"
}
CampoTipoDescrição
assignment_keystringChave do lote (UUID). Use-a em todas as chamadas seguintes do lote.
external_idstringO external_id enviado.
statusstringSempre pending_assets_insertion.

Erros​

StatusCódigoQuando acontece
400QIT000001O body não segue o formato: campo obrigatório ausente, tipo ou tamanho inválido, ou campo não aceito.
404TRC000001Não existe fundo com essa fund_class_key.
404TRC000002Não existe a configuração de contrato informada.
400TRC000004A configuração é de outro fundo.
400TRC000005A configuração está inativa.
400TRC000006O asset_type é diferente do tipo da configuração.
400TRC000052A configuração exige termo de cessão, mas não tem o modelo do termo. Fale com o time de integração.
400TRC000022CPF ou CNPJ do cedente inválido.
404TRC000003O cedente não está cadastrado.
409TRC000007Já existe um lote com esse external_id no fundo. Consulte-o em vez de recriar.
400TRC000046purchase_date anterior à data contábil do fundo.
400TRC000008Contrato de financiamento sem disbursement.
400TRC000009Confissão de dívida com disbursement.
404TRC000062O cedente não tem cadastro de contas.
404TRC000063O cedente não tem conta padrão, ou a account_key não é uma conta ativa dele.
403QIT000004 / QIT000005 / QIT000008O cedente, a gestora ou a consultoria da integração não tem acesso a este fundo ou configuração.

Em caso de erro de rede, reenvie com o mesmo external_id: um TRC000007 indica que o lote já foi criado, e ele aparece na listagem de lotes. Mais em Erros da API.