Visão geral

1. O que esta API oferece

A IORQ é uma gestora de FIDCs. Esta API é a interface programática para movimentar direitos creditórios dentro dos fundos que gerimos. Em uma única integração você pode:

• Ceder operações com lastro CCB para o FIDC (outros lastros no roadmap).
• Liquidar parcelas conforme os pagamentos vão sendo recebidos pelo tomador
• Recomprar, renegociar ou reverter operações que precisam sair antes da liquidação normal
• Receber webhooks em tempo real sobre o estado de cada operação
• Consultar estoque e indicadores da sua carteira no fundo

2. Filosofia da API

Três princípios guiam o design da IORQ API:

1. Agnóstica ao tipo de produto

Os endpoints de cessão, liquidação e pós-cessão são os mesmos para todos os produtos de crédito. O tipo é informado via campo no payload (product_type: personal_loan, financing ou cdc; backing_documents[].type) — não no path. Hoje o lastro suportado é CCB; novos lastros serão adicionados sem mudança de contrato.

2. Assíncrona por padrão

Operações que dependem de validação, sinalização para administradora ou processamento financeiro retornam imediatamente com confirmação de recebimento, e o resultado vem via webhook. Você nunca segura uma conexão esperando o ciclo bancário completar.

3. Idempotência primeiro

A chave de idempotência de negócio é o originator_proposal_code. Reenviar é seguro: a IORQ não duplica a operação. Crítico para integrações que dependem de retentativa.

📘

Por que importa

Esses três princípios significam que o cliente da API não precisa conhecer a topologia interna da IORQ (administradoras, bancarizadores, custodiantes) — basta seguir o contrato HTTP e consumir os webhooks.

3. O fluxo macro

Toda operação cedida ao fundo passa pelo mesmo ciclo macro, do desembolso à saída terminal:

flowchart LR
    O[Originação] --> C[Cessão]
    C --> A[Operação ativa]
    A --> L[Liquidação]
    A --> R[Recompra]
    A --> N[Renegociação]
    L --> X[Terminal]
    R --> X
    N --> X

Cada arco do diagrama corresponde a um fluxo operacional documentado nesta referência:

• Cessão de operações — entrada da operação no fundo
• Liquidação — saída normal por pagamento das parcelas
• Operações pós-cessão — saídas alternativas: recompra, renegociação, reversão

4. Quem usa esta API

Em todos os casos, o consumidor da API é referido genericamente como integrador nesta documentação.

5. O que esta API não faz

Para evitar surpresas, vale alinhar o escopo:

• Não emite o lastro. A CCB, duplicata ou contrato precisa estar formalizado antes da cessão. A IORQ não substitui o bancarizador.
• Não recebe pagamento direto do tomador. O pagamento é recebido na infraestrutura do integrador (boleto, débito, Pix). A IORQ apenas registra a baixa.
• Não gera o termo de cessão. O termo é gerado pela administradora a partir do lote sinalizado pela IORQ.
• Não executa cobrança. Cobrança ativa de tomador inadimplente é responsabilidade do originador.

6. Por onde começar

Se você está iniciando uma integração do zero, siga este caminho: