Antecipação de parcelas — multi-CCB (v2)

Versão atual e recomendada do endpoint de antecipação. Permite antecipar parcelas de múltiplas CCBs de um mesmo CPF em uma única requisição, gerando um boleto único.

Diferença da v1:

v1: somente uma CCB por requisição

v2: N parcelas de M CCBs, desde que todas pertençam ao mesmo CPF

Campos obrigatórios:

fund_id: UUID do fundo

due_date: data de vencimento do boleto de antecipação (YYYY-MM-DD)

total_prepayment_amount: valor total do boleto. Deve ser exatamente igual à soma de todos os prepayment_amount de todas as parcelas.

loans: lista de CCBs a antecipar (mínimo 1), cada uma com:

identifier: originator_proposal_code e/ou banker_proposal_code para localizar a CCB

code: código identificador desta antecipação para a CCB

prepayment_installments: parcelas a antecipar, cada uma com identifier (nosso_numero e/ou code) e prepayment_amount

Fluxo:

Envie esta requisição com as parcelas e o valor total

A IORQ valida CPFs, totais e emite o boleto

Aguarde o webhook status = issued_bolecode com o boleto gerado

Se o boleto for pago → parcelas baixadas e webhook status = settled_installment

Se o boleto não for pago → boleto cancelado; parcelas permanecem no fundo normalmente

curl --location 'https://auth-hs.iorq.com.br/installment/prepayment/v2' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "fund_id": "374485cf-f6df-467c-b91d-9f14082c6f36", "due_date": "2025-06-30", "total_prepayment_amount": 2000, "loans": [ { "identifier": { "originator_proposal_code": "34586674" }, "code": "prepay_001", "prepayment_installments": [ { "identifier": { "nosso_numero": "1001", "code": "1" }, "prepayment_amount": 1000 } ] }, { "identifier": { "originator_proposal_code": "34586675" }, "code": "prepay_002", "prepayment_installments": [ { "identifier": { "nosso_numero": "2001", "code": "1" }, "prepayment_amount": 1000 } ] } ] }'

Antecipação de parcelas — multi-CCB (v2)

Requisição

Respostas