Pular para o conteúdo principal

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

CampoTipoDescrição
webhook_typestringUm enumerador que define o tipo de evento sendo reportado
webhook_datetimestringData e hora do envio do webhook
request_control_keyuuid4Chave única de identificação da request do cliente.
payment_key *uuid4Chave única de identificação do pagamento.
barcode *stringCódigo de barras.
digitable_line *stringLinha digitável.
payment_type *enumTipo do pagamento.
payment_status *enumStatus do pagamento.

Enumeradores payment_type

EnumeradorTipoDescrição
bank_slipstringBoleto bancário
collection_slipstringFatura de recolhimento

Enumeradores payment_status

EnumeradorTipoDescrição
executedstringExecutado
revertedstringRevertido