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 de qualquer tipo de lastro (CCB, duplicata, contrato pré-pago) para o FIDC
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 lastro

Os endpoints de cessão, liquidação e pós-cessão são os mesmos para CCB, duplicata, contrato pré-pago e novos tipos que venham a ser suportados. O tipo é informado via campo no payload (product_type, backing_documents[].type) — não no path.

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

Todo endpoint mutador aceita uma chave de idempotência (originator_proposal_code ou idempotency_key). Reenviar é seguro: a IORQ retorna o estado atual sem duplicar 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

Perfil	Como usa	Volume típico
Originador	Origina o lastro, chama a cessão, notifica liquidações	Centenas a centenas de milhares de operações/mês
Bancarizador	Emite o lastro (em CCBs), pode operar como integrador em arranjos onde detém a relação com a IORQ	Varia
Plataforma de crédito	Origina e cede em nome de múltiplos sub-cedentes para FIDCs estruturados pela IORQ	Alto — fluxo contínuo
Administradora	Não consome esta API — recebe sinalizações via integração dedicada IORQ ↔ ADM	—

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:

Passo 1 — Ambientes e hosts

Conheça as URLs base de sandbox e produção. Confirme acesso de rede.

Passo 2 — Autenticação

OAuth2 client_credentials. Obtenha seu primeiro token Bearer JWT.

Passo 3 — Configurando webhooks

Registre sua URL pública e valide a assinatura HMAC.

Passo 4 — Quickstart

Primeira cessão de ponta a ponta em sandbox, em até 5 minutos.