Webhooks de boletos
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.
Introdução
Após a criação de um boleto dentro do nosso sistema, serão enviados webhooks com os seguintes status:
| Enumerador | Tradução | Descrição |
|---|---|---|
| registered | registrado | boleto registrado e disponível para pagamento. |
| rejected | rejeitado | solicitação de emissão de boleto rejeitada, quando a solicitação de registro do boleto contem erro de semântica que impede o registro. |
| payment_notice | aviso de pagamento | aviso de pagamento do boleto, essa notificação é enviada no momento que o boleto é pago, mas ainda não existe a liquidação financeira. |
| notary_office_payment_notice | aviso de pagamento em cartório | aviso de pagamento do boleto, essa notificação é enviada no momento que o boleto é pago em cartório, mas ainda não existe a liquidação financeira. |
| paid | pago | boleto pago (baixado com liquidação financeira). |
| written_off | baixado | boleto baixado sem liquidação financeira. |
info
O timeout para resposta de nosso webhooks é de 10 segundos.
Exemplos
Registro
Webhook Body
{
"key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
"data": {
"expiration": "2020-11-14",
"our_number": 11,
"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
"rebate_amount": 0,
"occurrence_type": "registration",
"occurrence_feedback": "confirmed",
"occurrence_sequence": 2,
"requester_profile_code": "329-01-0001-0078570",
"glados_occurrence_reasons": null,
"cnab_file_occurrence_order": 1,
"registration_institution_occurrence_date": "2020-11-11"
},
"status": "registered",
"webhook_type": "bank_slip.status_change",
"event_datetime": "2020-11-11 21:33:03"
}
Aviso de pagamento
Webhook Body
{
"key": "03c38d18-d12f-4b5f-841c-afab52fe33c5",
"data": {
"our_number": 142,
"paid_amount": 6676.38,
"payment_bank": 104,
"bank_slip_key": "03c38d18-d12f-4b5f-841c-afab52fe33c5",
"payment_method": 2,
"payment_origin": 3,
"paid_in": {
"name": "QI TECH",
"code_number": "329",
"ispb": "32402502"
},
"occurrence_type": "payment_notice",
"occurrence_feedback": "confirmed",
"occurrence_sequence": 0,
"requester_profile_code": "329-09-0001-0082162",
"registration_institution": "qi_scd",
"cnab_file_occurrence_order": 1,
"registration_institution_occurrence_date": "2021-04-19"
},
"status": "payment_notice",
"webhook_type": "bank_slip.status_change",
"event_datetime": "2021-04-19 20:04:06"
}
Tradução dos ID's de origem de pagamento:
| ID | Descrição |
|---|---|
| 1 | Postos tradicionais. |
| 2 | Terminal de Auto-atendimento. |
| 3 | Internet(home/office bank). |
| 5 | Correspondente bancário. |
| 6 | Central de atendimento (call center). |
| 7 | Arquivo eletrônico. |
| 8 | DDA. |
| 9 | Correspondente Digital. |
| 901 | Pagamento via Pix QR Code. |
Pagamento
Webhook Body: Pagamento via QR Code
{
"key": "505fd25f-89cf-40ca-927c-3800f207146a",
"data": {
"agent_type": "system",
"our_number": 69993012,
"origin_type": "qr_code",
"paid_amount": 551.5,
"payment_bank": "329",
"bank_slip_key": "505fd25f-89cf-40ca-927c-3800f207146a",
"payment_branch": "0001",
"payment_method": "2",
"payment_origin": "901",
"discount_amount": 0.0,
"occurrence_type": "payment",
"payment_account": "1727560-2",
"payment_bank_ispb": "32402502",
"occurrence_reasons": [289],
"occurrence_feedback": null,
"occurrence_sequence": "0",
"payment_credit_date": "2023-01-10",
"selected_user_agent": null,
"paid_in": {
"name": "QI TECH",
"code_number": "329",
"ispb": "32402502"
},
"paid_interest_amount": 0.0,
"requester_profile_code": "329-01-0001-0000002",
"registration_institution": "qi_scd",
"cnab_file_occurrence_order": 1,
"registration_institution_occurrence_date": "2023-01-10"
},
"status": "paid",
"webhook_type": "bank_slip.status_change",
"event_datetime": "2023-01-10 14:08:46"
}
Webhook Body: Pagamento via linha digitável
{
"key": "94cbc702-df42-4a84-bd03-d80728cde1e9",
"data": {
"our_number": 69993325,
"paid_amount": 261.49,
"payment_bank": 329,
"protocol_date": null,
"payment_branch": "0001",
"discount_amount": 0.0,
"occurrence_type": "payment",
"paid_in": {
"name": "QI TECH",
"code_number": "329",
"ispb": "32402502"
},
"paid_fine_amount": null,
"occurrence_sequence": "2",
"payment_credit_date": "2023-02-03",
"notary_office_number": null,
"paid_interest_amount": 0.0,
"notary_office_protocol": null,
"requester_profile_code": "329-01-0001-0000002",
"cnab_file_occurrence_order": 1,
"registration_institution_enumerator": "qi_scd",
"registration_institution_occurrence_date": "2023-02-02"
},
"status": "paid",
"webhook_type": "bank_slip.status_change",
"event_datetime": "2023-02-03 07:00:27"
}
Tradução dos ID's de origem de pagamento:
| ID | Descrição |
|---|---|
| 1 | Postos tradicionais. |
| 2 | Terminal de Auto-atendimento. |
| 3 | Internet(home/office bank). |
| 5 | Correspondente bancário. |
| 6 | Central de atendimento (call center). |
| 7 | Arquivo eletrônico. |
| 8 | DDA. |
| 9 | Correspondente Digital. |
| 901 | Pagamento via Pix QR Code. |
Baixa
Webhook Body
{
"key": "93e58a9a-287b-4bf2-9cdc-5467a9d3d9bf",
"data": {
"expiration": "2021-05-17",
"our_number": 113,
"bank_slip_key": "93e58a9a-287b-4bf2-9cdc-5467a9d3d9bf",
"rebate_amount": 0,
"occurrence_type": "write_off",
"occurrence_reasons": [],
"occurrence_feedback": "confirmed",
"occurrence_sequence": 3,
"requester_profile_code": "329-09-0001-0082162",
"glados_occurrence_reasons": null,
"cnab_file_occurrence_order": 1,
"registration_institution_occurrence_date": "2021-04-20"
},
"occurrence_reason": {
"bank_reason_code": "16",
"bank_reason_name": "Título Baixado pelo Banco por decurso de Prazo"
},
"status": "written_off",
"webhook_type": "bank_slip.status_change",
"event_datetime": "2021-04-20 11:55:09"
}
Tradução dos motivos da ocorrência de baixa:
| Código | Descrição |
|---|---|
| 00 | Ocorrência Aceita. |
| 10 | Baixa Comandada pelo cliente. |
| 14 | Título Protestado. |
| 16 | Título Baixado pela Instituição Financeira por decurso Prazo. |
| 20 | Título Baixado e Transferido para Desconto. |