Formato dos Webhooks

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.

Existem dois tipos de eventos no dda que serão diferenciados no webhook pelo atributo webhook_type

Webhook de captura de boleto

Registration webhook

    {
      "webhook_type": "baas.dda.bankslip.registration",
      "key": "7c52d5f6-9db1-4a3c-bb03-1f76a2e8f9d2",
      "data": {
        "barcode": "00193000000001000000500000001234567890123456",
        "digitable_line": "00193000000001000000500000001234567890123456123",
        "status": "registered",
        "nominal_amount": 1050,
        "total_amount": 999,
        "total_payment_amount": null,
        "paid_fine": null,
        "paid_interest": null,
        "discount_amount": null,
        "partial_payment_allowed": true,
        "expiration": "2024-07-19",
        "max_payment_date": "2024-09-02",
        "beneficiary": {
            "name": "Tech Solutions Ltda.",
            "bank_code": "123",
            "bank_ispb": "12345678",
            "person_type": "legal",
            "document_number": "12345678000100"
        },
        "payer": {
            "name": "João Carlos",
            "person_type": "natural",
            "document_number": "12345678900"
        },
        "guarantor": { 
            "name": "Maria Junior", 
            "person_type": "natural",
            "document_number": "03903984900" 
        },
        "rebate_amount": 30.00,
        "interest": [
            {
                "interest_amount_type": "workdays_daily_amount",
                "interest_billing_start_date": "2024-07-21",
                "interest_amount": 10.00
            }
        ],
        "fine": [
            {
                "fine_billing_start_date": "2024-07-29",
                "fine_amount_type": "absolute",
                "fine_amount": 100.00
            }
        ],
        "discounts": [
            {
                "discount_limit_date": "2024-07-05",
                "discount_type": "absolute",
                "discount_amount": 50.00
            }
        ],
        "calculations": [],
        "calculation_model": "01",
      }
    }

BODY PARAMS

Campo	Tipo	Descrição	Caracteres
barcode	string	Código de barras do boleto.	44
digitable_line	string	Linha digitável do boleto.	47
status	enum	Enumeradores de status de um boleto.	-
nominal_amount	float	Valor nominal do boleto.	-
total_amount	float	Valor calculado do boleto.	-
total_payment_amount	float	Valor de pagamento do boleto.	-
partial_payment_allowed	boolean	Indicador de aceite de pagamento parcial.	-
expiration	string	Data de vencimento do boleto.	10
max_payment_date	string	Data limite de pagamento do boleto.	10
payer	object	Objeto pagador do boleto.	-
beneficiary	object	Objeto beneficiário do boleto.	-
guarantor	object	Objeto sacador avalista do boleto	-
rebate_amount	float	Valor de rebate.	-
interest	list	Lista de objetos interest.	-
fine	list	Lista de objetos fine.	-
discounts	list	Lista de objetos discount.	-
calculations	list	Lista do grupo cálculo de boleto.	-
calculation_model	string	Método de cálculo do valor atual do boleto.	2

Enumeradores Status

Enumerador	Descrição
registered	Código de barras do boleto registrado.
paid	Boleto pago.
partially_paid	Boleto pago parcialmente.
written_off	Boleto baixado.

Objeto Payer

Campo	Tipo	Descrição	Caracteres
name	string	Nome do pagador.	-
person_type	string	Tipo de pessoa do pagador.	7
document_number	string	Documento do pagador.	14

Objeto Beneficiary

Campo	Tipo	Descrição	Caracteres
name	string	Nome do beneficiário.	-
person_type	string	Tipo de pessoa do beneficiário.	7
document_number	string	Documento do beneficiário.	14
bank_code	string	Código do banco do beneficiário.	3
bank_ispb	string	ISPB do banco do beneficiário.	8

Objeto guarantor

Campo	Tipo	Descrição	Caracteres
name	string	Nome do sacador avalista.	-
person_type	string	Tipo de pessoa do sacador avalista.	7
document_number	string	Documento do sacador avalista.	14

Objeto interest

Campo	Tipo	Descrição	Caracteres
interest_billing_start_date	string	Data de início do juros.	10
interest_amount_type	string	Tipo de juros.	-
interest_amount	string	Valor do juros.	-

Objeto fine

Campo	Tipo	Descrição	Caracteres
fine_billing_start_date	string	Data de início da multa.	10
fine_amount_type	string	Tipo de multa.	-
fine_amount	string	Valor da multa.	-

Objeto discount

Campo	Tipo	Descrição	Caracteres
discount_limit_date	string	Data limite do disconto.	10
discount_type	string	Tipo de desconto.	-
discount_amount	string	Valor do desconto.	-

Webhook de alteração de boleto

Update webhook

    {
      "webhook_type": "baas.dda.bankslip.update",
      "key": "7c52d5f6-9db1-4a3c-bb03-1f76a2e8f9d2",
      "data": {
        "barcode": "00193000000001000000500000001234567890123457",
        "digitable_line": "00193000000001000000500000001234567890123456123",
        "status": "paid",
        "nominal_amount": 1050,
        "total_amount": 1200,
        "total_payment_amount": 1200,
        "partial_payment_allowed": false,
        "paid_fine": 150,
        "paid_interest": 50,
        "discount_amount": 0,
        "expiration": "2024-05-30",
        "max_payment_date": "2024-07-01",
        "beneficiary": {
            "name": "Tech Solutions Ltda.",
            "bank_code": "123",
            "bank_ispb": "12345678",
            "person_type": "legal",
            "document_number": "12345678000100"
        },
        "payer": {
            "name": "João Carlos",
            "person_type": "natural",
            "document_number": "12345678900"
        },
        "guarantor": { 
            "name": "Maria Junior", 
            "person_type": "natural",
            "document_number": "03903984900" 
        },
        "rebate_amount": 30.00,
        "interest": [
            {
                "interest_amount_type": "workdays_daily_amount",
                "interest_billing_start_date": "2024-05-21",
                "interest_amount": 10.00
            }
        ],
        "fine": [
            {
                "fine_billing_start_date": "2024-05-29",
                "fine_amount_type": "absolute",
                "fine_amount": 100.00
            }
        ],
        "discounts": [
            {
                "discount_limit_date": "2024-05-05",
                "discount_type": "absolute",
                "discount_amount": 50.00
            }
        ],
        "calculations": [],
        "calculation_model": "01",
      }
    }

BODY PARAMS

Campo	Tipo	Descrição	Caracteres
barcode	string	Código de barras do boleto.	44
digitable_line	string	Linha digitável do boleto.	47
status	enum	Enumeradores de status de um boleto.	-
nominal_amount	float	Valor nominal do boleto.	-
total_amount	float	Valor calculado do boleto.	-
total_payment_amount	float	Valor de pagamento do boleto.	-
partial_payment_allowed	boolean	Indicador de aceite de pagamento parcial.	-
paid_fine	float	Total de multa efetivado no pagamento do boleto, calculado a partir do valor total.	-
paid_interest	float	Total de juros efetivado no pagamento do boleto, calculado a partir do valor total.	-
discount_amount	float	Total de descontos no pagamento do boleto, calculado a partir do valor total.	-
expiration	string	Data de vencimento do boleto.	10
max_payment_date	string	Data limite de pagamento do boleto.	10
payer	object	Objeto pagador do boleto.	-
beneficiary	object	Objeto beneficiário do boleto.	-
guarantor	object	Objeto sacador avalista do boleto	-
rebate_amount	float	Valor de rebate.	-
interest	list	Lista de objetos interest.	-
fine	list	Lista de objetos fine.	-
discounts	list	Lista de objetos discount.	-
calculations	list	Lista do grupo cálculo de boleto.	-
calculation_model	string	Método de cálculo do valor atual do boleto.	2