Notificar liquidação de parcela

post

https://hs-receiver-app-production.iorq.com.br/api/installment/settle

Registra o pagamento de uma parcela. Use o paid_amount real — pode ser menor (a menor/parcial, com is_partial_payment: true) ou maior (com encargos) que o valor previsto. payment_date no futuro é rejeitada. O integrador notifica; a IORQ apenas registra a baixa.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

fund_id

uuid

required

originator_proposal_code

string

required

Identificador da operação (o mesmo usado na cessão)

code

string

required

Código da parcela (campo code enviado em installments na cessão)

paid_amount

number

required

Valor efetivamente recebido, em BRL. Pode ser menor (a menor/parcial) ou maior (com encargos) que o previsto

payment_date

date

required

Data efetiva do pagamento (ISO). Datas futuras são rejeitadas

is_partial_payment

boolean

Defaults to false

true para pagamento parcial

Headers

iorq-fund-id

uuid

required

UUID do fundo (credit vehicle). Entregue por e-mail na seção Fundos liberados quando a IORQ provisiona seu acesso. Obrigatório em toda chamada à API operacional (hs-receiver) e ao serviço de webhooks (webhook-sender-manager). Deve corresponder ao fund_id informado no corpo ou na query quando aplicável.

Responses

201Liquidação registrada

400Requisição inválida — campo obrigatório ausente, formato inválido, arquivo maior que 2 MB ou nome de arquivo sem correspondência

401Token expirado, malformado ou ausente

404Recurso não encontrado