Liquidação de parcelas

POST

/installment/settle

Endpoint para notificar a IORQ que uma parcela de CCB foi liquidada (paga) pelo cliente final.

Utilizado quando a liquidação ocorre fora do fluxo normal de boleto emitido pela IORQ — por exemplo, pagamento direto ao originador, depósito identificado, ou qualquer canal externo.

Campos obrigatórios:

fund_id: UUID do fundo

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

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

nosso_numero: nosso_numero da bancarizadora para a parcela liquidada

paid_amount: valor efetivamente pago pelo cliente

payment_date: data da liquidação no formato YYYY-MM-DD

Fluxo:

O originador envia a notificação de liquidação.

A IORQ valida os dados e registra a liquidação.

O status final é comunicado via webhook com status = settled_installment.

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Liquidação de parcela recebida e processada com sucesso

Bodyapplication/json

🟠400Solicitação Incorreta

🟠401Não Autorizado

🔴500Erro do Servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://hs-receiver-app-development.iorq.com.br/api/installment/settle' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "fund_id": "374485cf-f6df-467c-b91d-9f14082c6f36",
    "originator_proposal_code": "34586674",
    "code": "1",
    "nosso_numero": "1001",
    "paid_amount": 541.62,
    "payment_date": "2025-02-10"
}'

Response Example

201 - Sucesso

{
    "status": "created",
    "message": "Installment settlement received successfully"
}

Modificado em 2026-05-08 16:45:19

Página anterior

Recompra de CCB

Próxima página

Liquidação antecipada de parcelas