Webhooks de indevidos

Informação

O timeout para resposta de nossos webhooks é de 5 segundos.

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.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Introdução

Este webhook é disparado automaticamente quando a QI Tech identifica e processa a devolução de um valor indevido. Após a validação, o sistema realiza a transferência via PIX para o tomador, utilizando a conta de desembolso cadastrada no sistema. O evento é enviado apenas quando a devolução é concluída com sucesso.

Webhook de devolução de indevidos

Response Body

{
    "callback": {
        "event_datetime": "2024-01-15T14:30:00.000Z",
        "key": "fb34e0ac-2c98-47e7-9040-406b8c3d80e7",
        "status": "refunded",
        "webhook_type": "laas.devolution.refund_receipt",
        "data": {
            "devolution_key": "fb34e0ac-2c98-47e7-9040-406b8c3d80e7",
            "devolution_amount": 150.75,
            "devolution_status": "refunded",
            "devolution_reason_description": "The payment arrived earlier than expected. The difference between the paid amount and the present value should be refund",
            "receipt_url": "https://storage.googleapis.com/receipts/devolution_receipt_12345.pdf",
            "document_key": "cd27a0c3-630d-4682-81b2-71b5b325bcde",
            "transacted_at": "2024-01-15T14:25:30.000Z"
        }
    }
}

Definições

Objeto callback

Campo	Tipo	Descrição	Obrigatório
event_datetime	string	Data e hora do evento no formato ISO 8601 UTC	Sim
key	string	Chave única da devolução	Sim
status	string	Status da devolução	Sim
webhook_type	string	Tipo do webhook	Sim
data	object	Dados específicos da devolução	Sim

Objeto data

Campo	Tipo	Descrição	Obrigatório
devolution_key	string	Chave única da devolução	Sim
devolution_amount	number	Valor da devolução em reais	Sim
devolution_status	string	Status atual da devolução	Sim
devolution_reason_description	string	Descrição do motivo da devolução	Sim
receipt_url	string	URL do comprovante da devolução	Sim
document_key	string	Chave do documento relacionado	Sim
transacted_at	string	Data e hora da transação no formato ISO 8601 UTC	Sim

Status possíveis

Status	Descrição
refunded	Devolução processada com sucesso

Exemplo de uso

Quando você receber este webhook, significa que uma devolução via PIX foi processada com sucesso. Você pode:

1. Verificar o status da devolução através do campo devolution_status
2. Acessar o comprovante através da URL fornecida em receipt_url
3. Identificar o valor devolvido através do campo devolution_amount
4. Verificar o motivo da devolução através do campo devolution_reason_description