Settlement webhooks
QI Tech webhooks should not be mapped in a restrictive manner. Additional fields may be included in the webhook payloads returned by our APIs.
You can check and resend webhooks following the detailed instructions in the documentation: Webhook Resending.
Introduction
In our system, settlement groups are a way to reconcile transactions with settled bank slips. This process (settlement) describes the transfer of value from a paid bank slip to the account that should receive this payment. In summary, whenever QI receives information that a bank slip has been paid by another bank or, in the case of protested bank slips, by the notary office, a settlement is created for that specific bank slip. Subsequently, settlement groups are created, which represent batches of settlements grouped by type.
At a later time, the payment transaction for this settlement group is made to the client's account. The transaction_key of this transaction is then saved for reconciliation purposes, so you can see all the bank slips that were settled in a specific transaction. For example, if you have five bank slips of R$ 5.00 each, where one was paid via notary office, one was paid via QR Code PIX and the other three were paid using the payment line or barcode by another bank, five settlements will be created for these bank slips. Then, these settlements will be grouped into three settlement groups: one of R$ 15.00 with the three bank slips paid using the payment line or barcode, for which a single transaction will be made, another of R$ 5.00 for the bank slip paid via QR Code PIX and the last one also of R$ 5.00 with the bank slip paid via notary office.
The timeout for response from our webhooks is 10 seconds.
Examples
Settlement group
Webhook Body
{
"webhook_type": "baas.bank_slip.bank_slip_settlement_group",
"webhook_datetime": "2024-08-13T21:35:55.679Z",
"data": {
"bank_slip_settlement_group_key": "87e6687b-d02b-45dc-b5b8-b51e16ec0a03",
"amount": 1,
"bank_slip_settlement_group_type": "siloc",
"bank_slip_settlement_group_status": "settled",
"transaction_key": "fc60a57e-c6ac-4e39-a3cf-2dc3c491dac6"
}
}
bank_slip_settlement_group_type enumerators
| Enumerator | Description |
|---|---|
| siloc | for payment of securities (security value less than R$ 250,000) |
| qr_code | for payment of securities made via QR Code |
| str | for payment of VR securities (security value greater than R$ 250,000) |
| notary_office | for payment of securities made via notary office |
bank_slip_settlement_group_status enumerators
| Enumerator | Description |
|---|---|
| pending | settlement group created but transaction was not executed |
| settled | settlement group created and transaction executed |