Overpayment webhooks

Information

The timeout for our webhooks response is 5 seconds.

Attention!

QI Tech webhooks should not be mapped in a restrictive way. Additional fields may be included in webhook payloads returned by our APIs.

Webhook Resending

You can check and resend webhooks by following the detailed instructions in the documentation: Webhook Resending.

Introduction

This webhook is automatically triggered when QI Tech identifies and processes the return of an overpayment amount. After validation, the system performs the transfer via PIX to the borrower, using the disbursement account registered in the system. The event is sent only when the return is successfully completed.

Overpayment refund webhook

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"
        }
    }
}

Definitions

Callback object

Field	Type	Description	Required
event_datetime	string	Event date and time in ISO 8601 UTC format	Yes
key	string	Unique devolution key	Yes
status	string	Devolution status	Yes
webhook_type	string	Webhook type	Yes
data	object	Specific devolution data	Yes

Data object

Field	Type	Description	Required
devolution_key	string	Unique devolution key	Yes
devolution_amount	number	Devolution amount in reais	Yes
devolution_status	string	Current devolution status	Yes
devolution_reason_description	string	Description of the devolution reason	Yes
receipt_url	string	Devolution receipt URL	Yes
document_key	string	Related document key	Yes
transacted_at	string	Transaction date and time in ISO 8601 UTC format	Yes

Possible statuses

Status	Description
refunded	Devolution processed successfully

Usage example

When you receive this webhook, it means that a PIX refund has been processed successfully. You can:

1. Check the devolution status through the devolution_status field
2. Access the receipt through the URL provided in receipt_url
3. Identify the refunded amount through the devolution_amount field
4. Check the reason for the devolution through the devolution_reason_description field