Skip to main content

Boletos webhook

Attention!

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

Introduction​

After the creation of a boleto within our system, webhooks with the following status will be sent:

EnumeratorTranslationDescription
registeredregisteredboleto registered and available for payment.
rejectedrejectedboleto issuance request rejected when the boleto registration request contains a semantic error that prevents registration.
payment_noticepayment noticeboleto payment notice, this notification is sent when the boleto is paid, but financial settlement has not yet occurred.
notary_office_payment_noticenotary office payment noticeboleto payment notice, this notification is sent when the boleto is paid at a notary office, but financial settlement has not yet occurred.
paidpaidboleto paid (settled with financial liquidation).
written_offwritten offboleto written off without financial settlement.
info

The timeout for our webhook response is 10 seconds.

Examples​

Regiser​

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"
}

Payment notice​

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"
}

Translation of payment origin IDs:

IDDescription
1Traditional branches.
2Self-service terminal.
3Internet (home/office bank).
5Banking correspondent.
6Call center.
7Electronic file.
8DDA.
9Digital Correspondent.
901Payment via Pix QR Code.

Payment​

Webhook Body: Payment 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: Payment via digitable line
{
	"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"
}

Translation of payment origin IDs:

IDDescription
1Traditional branches.
2Self-service terminal.
3Internet (home/office bank).
5Banking correspondent.
6Call center.
7Electronic file.
8DDA.
9Digital correspondent.
901Payment 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"
}

Translation of write-off occurrence reasons:

CodeDescription
00Occurrence Accepted.
10Write-off Commanded by the client.
14Protested Title.
16Title Written Off by the Financial Institution due to Elapsed Time.
20Title Written Off and Transferred for Discount.