Webhooks de Liquidação

Ao longo do processamento das liquidações, o sistema envia webhooks para notificar o parceiro integrador sobre mudanças de status de cada liquidação individual. Todos os webhooks possuem o tipo settlement.settlement_status_change e identificam a liquidação pelo settlement_external_id fornecido na criação.

Configuração de webhooks

Para receber webhooks, é necessário ter uma URL de callback configurada junto à QI Tech. Entre em contato com integracao.dtvm@qitech.com.br para configurar.

Estrutura do webhook

Todos os webhooks de liquidação seguem a mesma estrutura:

Campo	Tipo	Descrição
webhook_type	string	Sempre settlement.settlement_status_change.
webhook_datetime	string	Data e hora do evento no formato ISO 8601.
data	array	Lista com os dados do evento. Veja tabela abaixo.

Atributos de cada objeto em data

Campo	Tipo	Descrição
payment_batch_external_id	string	O external_id do lote de pagamento.
settlement_external_id	string	O external_id da liquidação.
settlement_status	string	Novo status da liquidação.
settlement_type	string	Tipo de liquidação (ex: installment_settlement, asset_settlement).
total_value	number	Valor total da liquidação em reais.
fund_class_document_number	string	CNPJ do fundo associado.
contract_number	string	Número do contrato. Presente quando informado na criação da liquidação.
installment_number	integer	Número da parcela. Presente quando aplicável.
installment_maturity_date	string	Data de vencimento da parcela. Presente quando aplicável.
source_document_number	string	CPF/CNPJ da contraparte financeira. Presente quando informado na criação do lote.

Estrutura padrão do webhook

{
    "data": [
        {
            "payment_batch_external_id": "ac597f90-a13e-4f78-86f0-11c66f5fa6d6",
            "settlement_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
            "settlement_status": "STATUS",
            "settlement_type": "installment_settlement",
            "total_value": 130.50,
            "fund_class_document_number": "60.910.091/0001-24"
        }
    ],
    "webhook_type": "settlement.settlement_status_change",
    "webhook_datetime": "2024-04-23T15:08:30Z"
}

---

Eventos por status

Liquidação Concluída

STATUS

settled

Enviado quando a liquidação é processada com sucesso e o valor foi devidamente conciliado na carteira do fundo. Este é o status final de uma liquidação bem-sucedida.

Webhook Body

{
    "data": [
        {
            "payment_batch_external_id": "ac597f90-a13e-4f78-86f0-11c66f5fa6d6",
            "settlement_external_id": "1caff47c-bd05-48b0-a6bc-9569f5070f6b",
            "settlement_status": "settled",
            "settlement_type": "installment_settlement",
            "total_value": 130.50,
            "fund_class_document_number": "60.910.091/0001-24"
        }
    ],
    "webhook_type": "settlement.settlement_status_change",
    "webhook_datetime": "2024-04-23T15:08:30Z"
}