Webhooks de parcelas
Informação
O timeout para resposta de nosso webhooks é de 10 segundos.
Atenção!
Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
Essa configuração pode ser habilitada quando a QI Tech é o agente de cobrança da operação, com ela você receberá as mudanças de status nas parcelas da operação.
Os status que podem ser configurados são:
- opened (aberto)
- paid (pago)
- waiting_payment (aguardando pagamento)
- paid_early (pago antecipadamente)
- paid_partial (pago parcialmente)
- overdue (vencido)
- paid_partial_overdue (pago parcialmente após o vencimento)
- paid_overdue (pago após o vencimento)
Exemplo de webhook de parcela paga
Body.json
{
"key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0",
"data": {
"status": "paid",
"installment": {
"events": [{
"amount": null,
"created_at": "2022-08-27T10:55:41",
"event_date": "2022-08-27T10:55:42",
"old_due_date": null,
"installment_event_type": {
"enumerator": "open",
"translation_path": "co.InstallmentEventType.open"
},
"installment_old_status": {
"enumerator": "created",
"translation_path": "co.InstallmentStatus.created"
}
}, {
"amount": 1009.68,
"created_at": "2022-09-27T07:03:35",
"event_date": "2022-09-27T07:03:34",
"old_due_date": null,
"installment_event_type": {
"enumerator": "payment",
"translation_path": "co.InstallmentEventType.payment"
},
"installment_old_status": {
"enumerator": "opened",
"translation_path": "co.InstallmentStatus.opened"
}
}],
"paid_at": "2022-09-27T07:03:34",
"due_date": "2022-10-28",
"workdays": 21,
"created_at": "2022-08-27T10:54:18",
"tax_amount": 5.11785875,
"updated_at": "2022-09-27T07:03:35",
"fine_amount": null,
"paid_amount": 1009.68,
"qr_code_key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0",
"qr_code_url": "https://qitech.com.br/",
"due_interest": 0,
"has_interest": true,
"payment_type": {
"enumerator": "bankslip",
"translation_path": "co.PaymentType.bankslip"
},
"total_amount": 1009.68,
"bank_slip_key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0",
"calendar_days": 30,
"due_principal": 1006.66428708,
"digitable_line": "32990001031000699917042000000200291520000100968",
"installment_key": "92a05d9c-e457-4f28-9fa8-86be638ee2d0",
"additional_costs": [],
"installment_type": {
"enumerator": "principal",
"translation_path": "co.InstallmentType.principal"
},
"pre_fixed_amount": 3.02013568,
"business_due_date": "2022-10-31",
"cetip_settlements": [],
"post_fixed_amount": 0,
"total_paid_amount": 0,
"installment_number": 3,
"installment_status": {
"enumerator": "paid",
"translation_path": "co.InstallmentStatus.paid"
},
"installment_payment": [{
"created_at": "2022-09-27T07:03:35",
"paid_amount": 1009.68,
"total_amount": 1009.68,
"due_principal": 1006.66428708,
"reference_date": "2022-09-27",
"paid_method_type": {
"enumerator": "pix",
"translation_path": "co.PaymentType.pix"
},
"payment_data":{
"paid_in":{
"name": "ITAÚ UNIBANCO S.A.",
"code_number": 341,
"ispb": 60701190
}
},
"pre_fixed_amount": 3.02013568,
"advanced_paid_amount": 0,
"present_total_amount": 1009.68,
"renegotiation_proposal_key": null,
"principal_amortization_amount": 1006.65986432,
"prefixed_interest_payment_amount": 3.02013568,
"principal_amortization_payment_amount": 1006.65986432
}],
"advanced_paid_amount": 0,
"total_accrual_amount": 0,
"original_total_amount": 1009.68,
"accrual_reference_date": "2022-09-27",
"original_due_principal": 1006.66428708,
"original_pre_fixed_amount": 3.02013568,
"renegotiation_proposal_key": null,
"principal_amortization_amount": 1006.65986432,
"original_principal_amortization_amount": 1006.65986432
},
"is_finished": true
},
"webhook_type": "installment.status_change"
}
Exemplo de webhook de criação de boletos para pagamento de parcelas
Body.json
{
"key": "96015228-4905-42fc-bda6-e70e0e552b6b",
"webhook_type": "installment.status_change",
"data": {
"status": "update",
"installments": [
{
"installment_key": "bc60ad8e-4dc1-4edc-8c5b-6df1b5c9415d",
"digitable_line": "32990001455000000000503007797909797660000100000",
"qr_code_key": "7d20015e-c4ed-4290-b255-33c1c5b56362",
"qr_code_url": "00020126580014br.gov.bcb.pix0136dc4a27db-2fe1-474d-aa02-88d6fffb8d0d5204000053039865802BR5921NeymarSportEMarketing6008saopaulo62070503***63040EB2",
"principal_amortization_amount": 141.07452576,
"pre_fixed_amount": 72.89547424,
"bank_slip_key": "5f25e9fd-f612-47a3-acff-be9f29d87f6c",
"due_date": "2024-07-17",
"total_amount": 216.97
},
{
"principal_amortization_amount": 144.84483469,
"pre_fixed_amount": 65.12516531,
"due_date": "2024-08-19",
"digitable_line": "32990001454000000000627007797908997530000500000",
"installment_key": "be3f0fde-24ac-42d2-82e9-4b0aa15bf01e",
"qr_code_key": "4d696847-73a2-4dba-be9f-218084dff8e7",
"qr_code_url": "00020126580014br.gov.bcb.pix0136dc4a27db-2fe1-474d-aa02-88d6fffb8d0d5204000053039865802BR5921NeymarSportEMarketing6008saopaulo62070503***63040EB2",
"total_amount": 216.97,
"bank_slip_key": "bc1cc18f-2db5-470d-8541-b944e53cb699"
},
{
"qr_code_url": "00020126580014br.gov.bcb.pix0136dc4a27db-2fe1-474d-aa02-88d6fffb8d0d5204000053039865802BR5921NeymarSportEMarketing6008saopaulo62070503***63040EB2",
"digitable_line": "32990001454000000000623007797907697530000500000",
"bank_slip_key": "8a00a520-7d49-4f51-9293-9ea26e241338",
"principal_amortization_amount": 164.37001228,
"installment_key": "3d4b5f21-c0a3-4075-bac2-9086cd90b77e",
"due_date": "2024-09-17",
"qr_code_key": "4d47528a-167d-41aa-b9da-246d2030af75",
"total_amount": 216.97,
"pre_fixed_amount": 52.59998772
}
]
}
}
Definições
Object Request Body
| Campo | Tipo | Descrição | Máx. Caract. |
|---|---|---|---|
| key * | object | DEBT-KEY da operação de crédito da referida parcela. | - |
| data * | object | Dados do webhook. | - |
| webhook_type * | object | Tipo do webhook enviado. | - |
Object data
| Campo | Tipo | Descrição | Máx. Caract. |
|---|---|---|---|
| status * | object | Status da parcela | - |
| installment * | object | Dados da parcela | - |
| is_finished * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - |
Object installment
| Campo | Tipo | Descrição | Máx. Caract. |
|---|---|---|---|
| events * | object | Status da parcela | - |
| paid_at * | object | Dados da parcela | - |
| due_date * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - |
| workdays * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - |
| created_at * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - |
| tax_amount * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - |
| updated_at * | booleano | Campo booleano indicando se existem novos status para a parcela ou se já esta finalizada. | - |