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

Ao longo do ciclo de vida dos boletos, dentro do nosso sistema, serão enviados webhooks com os seguintes status do boleto (bank_slip_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 por erros de validação
payment_notice	aviso de pagamento	Aviso de pagamento do boleto (boleto pago mas pagamento ainda não liquidado)
notary_office_payment_notice	aviso de pagamento em cartório	Aviso de pagamento em cartório do boleto (boleto pago mas pagamento ainda não liquidado)
paid	pago	Boleto pago e liquidado financeiramente
written_off	baixado	Boleto baixado (não pode mais ser pago) e sem liquidação financeira
payment_blocked	bloqueado para pagamento	Bloqueado para pagamento devido a fluxo de protesto

E os webhooks são enviados sempre que são confirmadas ocorrências dos seguintes tipos (occurrence_type):

Enumerador	Tradução	Descrição
registration	registro	Registro do boleto
rebate	abatimento	Abatimento de parte do valor base do título
cancel_rebate	cancelamento de abatimento	Cancelamento de abatimento existente
extension	extensão	Extensão da data de expiração do título
write_off	baixa	Baixa do boleto
protest_write_off	baixa por protesto	Baixa do boleto por protesto em cartório
payment_write_off	baixa por pagamento	Baixa do boleto por pagamento
discount	desconto	Alteração dos descontos
fine	multa	Alteração da multa
interest	juros	Alterações dos juros
protest_request	pedido de protesto	Pedido de protesto em cartório
bankruptcy_protest_request	pedido de protesto falimentar	Pedido de protesto falimentar em cartório
notary_office_entry	entrada em cartório	Ocorrência de entrada do título em cartório
protest_cancel_request	desistência de pedido de protesto	Desistência do pedido de protesto corrente
protest_remove_request	sustação de protesto	Sustação do protesto do título
notary_office_exit	saída do cartório	Ocorrência de saída do título do cartório
payment_notice	aviso de pagamento	Aviso de pagamento do boleto (boleto pago mas pagamento ainda não liquidado)
notary_office_payment_notice	aviso de pagamento em cartório	Aviso de pagamento em cartório do boleto (boleto pago mas pagamento ainda não liquidado)
payment	pagamento	Notificação de que o boleto foi pago e baixado

Informação

O timeout para resposta de nosso webhooks é de 10 segundos.

Exemplos

Registro

Webhook Body: ocorrência aceita

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "9077cc0b-5bbd-4432-888e-6bf6384c250a",
		"occurrence_type": "registration",
		"occurrence_status": "confirmed"
	}
}

Webhook Body: ocorrência rejeitada

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "ae783ed7-b892-4e48-8480-b045e3b492f5",
		"bank_slip_status": "rejected",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "registration",
		"occurrence_status": "rejected"
	}
}

Abatimento/cancelamento de abatimento

Webhook Body: abatimento

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "rebate",
		"occurrence_status": "confirmed"
	}
}

Webhook Body: cancelamento de abatimento

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "cancel_rebate",
		"occurrence_status": "confirmed"
	}
}

Prorrogação

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "extension",
		"occurrence_status": "confirmed"
	}
}

Desconto

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "a8df1c2e-77ff-49ea-9e7a-8fd536a6e357",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "discount",
		"occurrence_status": "confirmed"
	}
}

Juros

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "69f3f345-07c5-4c80-a8dd-51054afdad01",
		"bank_slip_status": "registered",
		"occurrence_key": "8550e47a-7554-455c-bdd8-cf0c048a277c",
		"occurrence_type": "interest",
		"occurrence_status": "confirmed"
	}
}

Multa

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "97e6edab-b793-4eb6-a1a7-0a27e1d5c73e",
		"bank_slip_status": "registered",
		"occurrence_key": "47b06bdb-c006-47a7-81f2-7aac7fff823b",
		"occurrence_type": "fine",
		"occurrence_status": "confirmed"
	}
}

Baixa

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "45c21054-57fd-4d28-8d5a-0cdc5cb29670",
		"bank_slip_status": "written_off",
		"occurrence_key": "0b92bd47-fae5-46c0-8c40-e5aebc9ecd28",
		"occurrence_type": "write_off",
		"occurrence_status": "confirmed"
	}
}

Baixa por protesto

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-25T18:05:01.395Z",
	"data": {
		"bank_slip_key": "7182639f-dea5-46c6-99c6-af0d94d772cb",
		"bank_slip_status": "written_off",
		"occurrence_key": "93380917-beee-4f3e-af01-6c24e140d53d",
		"occurrence_type": "protest_write_off",
		"occurrence_status": "confirmed"
	}
}

Baixa por pagamento

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-18T18:02:15.152Z",
	"data": {
		"bank_slip_key": "40d6a1bc-cfed-4444-a901-e02ecc169ce5",
		"bank_slip_status": "written_off",
		"occurrence_key": "78221daa-945f-485b-b39c-97ef0e251afe",
		"occurrence_type": "payment_write_off",
		"occurrence_status": "confirmed"
	}
}

Pedido de protesto

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-16T20:54:13.013Z",
	"data": {
		"bank_slip_key": "f03c5fec-b31c-402a-b832-80da8a493653",
		"bank_slip_status": "payment_blocked",
		"occurrence_key": "304958f6-cdf2-4fb1-b8f3-5482030bf0eb",
		"occurrence_type": "protest_request",
		"occurrence_status": "confirmed"
	}
}

Pedido de protesto falimentar

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-16T20:54:13.013Z",
	"data": {
		"bank_slip_key": "21aeefb4-4fa1-4e32-b2bb-32a7486128f0",
		"bank_slip_status": "payment_blocked",
		"occurrence_key": "11a7e9e8-4667-471b-bc3f-2f65f77e22e9",
		"occurrence_type": "bankruptcy_protest_request",
		"occurrence_status": "confirmed"
	}
}

Entrada em cartório

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-17T18:00:48.341Z",
	"data": {
		"bank_slip_key": "5bc4c1d4-d51b-4b0b-b308-81850d04e523",
		"bank_slip_status": "payment_blocked",
		"occurrence_key": "159e6e3f-fce5-4362-829e-1595fc14d66c",
		"occurrence_type": "notary_office_entry",
		"occurrence_status": "confirmed"
	}
}

Cancelamento de protesto

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-23T18:00:52.374Z",
	"data": {
		"bank_slip_key": "96d2a896-f2da-484c-8d40-20fabbde15ee",
		"bank_slip_status": "registered",
		"occurrence_key": "2505fedf-0061-478b-b45e-8420b755ebbb",
		"occurrence_type": "protest_cancel_request",
		"occurrence_status": "confirmed"
	}
}

Sustação de protesto

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-30T18:01:00.452Z",
	"data": {
		"bank_slip_key": "878d462e-be4e-40bd-b797-b831fef87f48",
		"bank_slip_status": "written_off",
		"occurrence_key": "cb08785d-0a4d-41f4-a64c-bafe730b175b",
		"occurrence_type": "protest_remove_request",
		"occurrence_status": "confirmed"
	}
}

Saída do cartório

Webhook Body

{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-11-01T18:01:01.949Z",
	"data": {
		"bank_slip_key": "79d07a3d-3953-4195-a2e2-bbbf10635f27",
		"bank_slip_status": "registered",
		"occurrence_key": "c703b04c-7334-40fe-bf8d-b43bd991dbab",
		"occurrence_type": "notary_office_exit",
		"occurrence_status": "confirmed"
	}
}

Aviso de pagamento

Primeiro webhook: boleto foi pago, mas ainda não foi liquidado

Webhook Body

{
	"webhook_type": "baas.bank_slip.payment_notice",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"bank_slip_status": "payment_notice",
		"occurrence_key": "d0341ad7-aa87-4dad-929b-38c8c9218f23",
		"occurrence_type": "payment_notice",
		"occurrence_status": "confirmed"
	}
}

Aviso de pagamento em cartório

Primeiro webhook: boleto foi pago em cartório, mas ainda não foi liquidado

Webhook Body

{
	"webhook_type": "baas.bank_slip.notary_office_payment_notice",
	"webhook_datetime": "2024-10-16T18:00:43.621Z",
	"data": {
		"bank_slip_key": "05f2b81b-b241-4e72-9b2c-7312257a0284",
		"bank_slip_status": "notary_office_payment_notice",
		"occurrence_key": "3ecab7b1-c991-4d91-8d71-08a34eec1d7d",
		"occurrence_type": "notary_office_payment_notice",
		"occurrence_status": "confirmed"
	}
}

Pagamento

Webhook Body

{
	"webhook_type": "baas.bank_slip.payment",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"bank_slip_status": "paid",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "payment",
		"occurrence_status": "confirmed",
		"paid_amount": 850.0,
		"paid_rebate_amount": 200.0,
		"paid_discount_amount": 0.0,
		"paid_fine_amount": 0.0,
		"paid_interest_amount": 50.0,
		"payment_method": "account_debit",
		"payment_origin": "qr_code",
		"payment_credit_date": "2024-07-02"
	}
}

Enumeradores payment_origin

Enumerador	Descrição
cash	Espécie
account_debit	Débito em conta
credit_card	Cartão de crédito
check	Cheque

Enumeradores payment_origin

Enumerador	Descrição
phisical_cashier	Agências - Postos tradicionais
taa	Terminal de Auto-atendimento
internet	Internet (home/office bank)
corban	Correspondente bancário
call_center	Central de atendimento (call center)
eletronic_file	Arquivo eletrônico
dda	DDA
digital_correspondent	Correspondente Digital
qr_code	Pagamento via Pix QR Code

Webhooks de boletos

Introdução​

Exemplos​

Registro​

Abatimento/cancelamento de abatimento​

Prorrogação​

Desconto​

Juros​

Multa​

Baixa​

Baixa por protesto​

Baixa por pagamento​

Pedido de protesto​

Pedido de protesto falimentar​

Entrada em cartório​

Cancelamento de protesto​

Sustação de protesto​

Saída do cartório​

Aviso de pagamento​

Aviso de pagamento em cartório​

Pagamento​

Enumeradores payment_origin​

Enumeradores payment_origin​

Introdução

Exemplos

Registro

Abatimento/cancelamento de abatimento

Prorrogação

Desconto

Juros

Multa

Baixa

Baixa por protesto

Baixa por pagamento

Pedido de protesto

Pedido de protesto falimentar

Entrada em cartório

Cancelamento de protesto

Sustação de protesto

Saída do cartório

Aviso de pagamento

Aviso de pagamento em cartório

Pagamento

Enumeradores payment_origin

Enumeradores payment_origin