Liquidação antecipada de parcelas

Endpoint para notificar a IORQ que uma ou mais parcelas de CCB foram antecipadas (pagas antes do vencimento) pelo cliente final.

Campos obrigatórios:

fund_id: UUID do fundo

originator_proposal_code: código da proposta no originador (identifica unicamente a CCB)

identifier: objeto contendo códigos de identificação da proposta:

originator_proposal_code (opcional): se não informado, será preenchido automaticamente com o originator_proposal_code do nível raiz. Se informado e diferente do nível raiz, retornará erro de validação.

banker_proposal_code (opcional): código da proposta no bancarizador, utilizado como fallback para localizar a CCB quando a busca por originator_proposal_code não encontrar resultados.

code: código de ordem da parcela de referência (mesmo enviado em CreateLoanRequest.installments[].code)

due_date: data de vencimento original da parcela de referência (YYYY-MM-DD)

total_prepayment_amount: valor total antecipado. Deve ser exatamente igual à soma de prepayment_installments[].prepayment_amount.

prepayment_installments: lista das parcelas sendo antecipadas, cada uma com nosso_numero e prepayment_amount.

Campos opcionais:

nosso_numero (nível raiz): não deve ser enviado quando a IORQ emitiu o boleto. Enviar apenas quando o nosso_numero foi informado originalmente pelo originador.

Fluxo:

O originador envia a notificação de antecipação com a lista de parcelas e valores.

A IORQ localiza o empréstimo pelo originator_proposal_code ou, como fallback, pelo banker_proposal_code informado no identifier.

A IORQ valida o total contra a soma das parcelas individuais e registra a antecipação.

O resultado é comunicado via webhook com status = received_prepayment.

curl --location 'https://hs-receiver-app-development.iorq.com.br/api/installment/prepayment' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "fund_id": "374485cf-f6df-467c-b91d-9f14082c6f36", "originator_proposal_code": "34586674", "identifier": { "originator_proposal_code": "34586674", "banker_proposal_code": "BNK-2025-001" }, "code": "1", "due_date": "2025-03-05", "total_prepayment_amount": 1000, "prepayment_installments": [ { "nosso_numero": "1001", "prepayment_amount": 500 }, { "nosso_numero": "1002", "prepayment_amount": 500 } ] }'

Liquidação antecipada de parcelas

Requisição

Respostas