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.

Webhook para pagamentos pendentes

Webhook destinado para atualizar o status dos pagamentos que ficaram pendentes (status 202) na realização de um pagamento de boleto bancário.

Webhook Request Body

Request Body: Pagamento executado

{
  "webhook_type": "baas.bill_payment.payment",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "payment_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "barcode":"00193967000009910000000003615574000000002417",
    "digitable_line":"00190000090361557400500000024174396700000991000",
    "payment_status": "executed",
    "payment_type":"bank_slip"
  }
}

Request Body: Pagamento revertido

{
  "webhook_type": "baas.bill_payment.payment",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "payment_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "barcode":"00193967000009910000000003615574000000002417",
    "digitable_line":"00190000090361557400500000024174396700000991000",
    "payment_status": "reverted",
    "payment_type":"bank_slip"
  }
}

Webhook Body Params

Campo	Tipo	Descrição
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado
webhook_datetime	string	Data e hora do envio do webhook
request_control_key	uuid4	Chave única de identificação da request do cliente.
payment_key *	uuid4	Chave única de identificação do pagamento.
barcode *	string	Código de barras.
digitable_line *	string	Linha digitável.
payment_type *	enum	Tipo do pagamento.
payment_status *	enum	Status do pagamento.

Enumeradores payment_type

Enumerador	Tipo	Descrição
bank_slip	string	Boleto bancário
collection_slip	string	Fatura de recolhimento

Enumeradores payment_status

Enumerador	Tipo	Descrição
executed	string	Executado
reverted	string	Revertido