Skip to main content

Installment payment webhooks

Information

The timeout for our webhook responses is 10 seconds.

Attention!

QI Tech webhooks should not be mapped in a restrictive manner. Additional fields may be included in the webhook payloads returned by our APIs.

Webhook Resending

You can check and resend webhooks by following the detailed instructions in the documentation: Webhook Resending.


Example of paid installment webhook

{
"key": "4219cb7b-32b9-45d1-b19c-24fbca04ca02",
"webhook_type": "laas.credit_operation.installment.payment",
"event_datetime": "2026-01-14 04:08:30",
"data": {
"installment_key":"1234cb7b-3329-12d1-429c-24f84975ca02",
"reference_date":"2026-02-13",
"paid_at":"2026-02-13 20:38:07",
"paid_method_type":"pix",
"installment_status":"paid_early",
"installment_payment_key":"2accee19-ed22-43f9-9573-3b6232658337",
"paid_amount":567.73,
"total_amount":567.73,
"present_total_amount":567.73,
"prefixed_interest_payment_amount":556.73948769,
"principal_amortization_payment_amount":10.99051231,
"resource_account_key":"422cee19-ed22-43f9-9573-3b6111658337",
"batch_renegotiation_proposal_key":null,
"renegotiation_proposal_key":null,
"received_portability_key":null,
"refinancing_credit_operation_key":null,
"bank_slip_key":null,
"pix_qrcode_key":"3b61ee19-ed22-6119-9573-3b6119573337",
"paid_in":{
"name": "ITAÚ UNIBANCO S.A.",
"code_number": 341,
"ispb": 60701190
}
},
}

Appendix

FieldTypeDescription
keyUUIDdebt identifier key (credit_operation_key or DEBT_KEY)
installment_keyUUIDinstallment identifier key
reference_dateDateReference date for calculating the installment outstanding balance
paid_atDateTimePayment date
paid_method_typestringPayment method, check the possible enumerators in the Enumerators for paid_method_type table
installment_statusstringInstallment status, check the possible enumerators in the Enumerators for installment_status table
installment_payment_keyUUIDUnique payment key
paid_amountdecimalAmount paid
total_amountdecimalTotal installment amount, in case of partial payment it is updated with the outstanding amount
present_total_amountdecimalPresent value on the reference date (reference_date)
prefixed_interest_payment_amountdecimalPayment amount referring to interest amortization
principal_amortization_payment_amountdecimalPayment amount referring to principal amortization
resource_account_keyUUIDSource account of the balance used in settlement
batch_renegotiation_proposal_keyUUIDBatch renegotiation key, if applicable
renegotiation_proposal_keyUUIDRenegotiation key, if applicable
refinancing_credit_operation_keyUUIDRefinancing operation key, if applicable
received_portability_keyUUIDReceived portability key, if applicable
bank_slip_keyUUIDBank slip key registered with the installment, if applicable
pix_qrcode_keyUUIDPIX QR code key registered with the installment, if applicable
paid_inobjectPayer bank information, applicable in cases of PIX or bank slip payments
Fine and late fee payment amount

The fine + late fee amount (fine_amount) of the payment can be identified through the formula:

fine_amount = paid_amount - prefixed_interest_payment_amount - principal_amortization_payment_amount.

EnumeratorDescription
bankslipBank slip
tedTED
pixPIX
refinancingrefinancing
portabilityportability
unmonitoredmanual write-off
collateralcollateral

Enumerators for installment_status

EnumeratorDescription
createdopen
openedopen
waiting_paymentopen waiting payment on due date
paid_partialpartially paid
paidpaid
paid_earlypaid early
overdueoverdue
paid_partial_overduepartially paid overdue
paid_overduepaid overdue
canceledcanceled
unmonitoredopen
waiting_payment_confirmationwaiting refinancing settlement
Partially paid early

Note that there is no partially paid early status. In case of a partial write-off with a reference date prior to the installment due date, the previous status is maintained (unmonitored or opened).