Webhook de Criação de Lote de Conciliação de Ordens de Pagamento

As notificações via webhook são essenciais para processamento de eventos sobre conciliação de pagamentos no Pix Automático. Este webhook informa sobre a criação de lotes de conciliação de ordens de pagamento.

Webhook de Criação de Lote de Conciliação

Este webhook é emitido quando um novo lote de conciliação de ordens de pagamento é criado.

Atenção!

Os webhooks da QI Tech não devem ser mapeados de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Webhook Request Body

Request Body: Jornada 1

{
    "webhook_type": "baas.automatic_pix.payment_order_conciliation_batch.creation",
    "webhook_datetime": "2021-10-22T20:30:23.459Z",
    "data": {
        "payment_order_conciliation_batches": [
            {
                "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
                "payment_order_conciliation_batch_status": "open",
                "payment_order_conciliation_batch_type": "fixed_amount",
                "account_key": "uuid",
                "total_amount": 0,
                "conciliated_amount": 0,
                "total_payment_orders": 0,
                "conciliated_payment_orders": 0,
                "reference_date": "2025-06-13",
                "created_at": "2025-06-10T20:30:23.459Z"
            },
            {
                "payment_order_conciliation_batch_key": "99fc62fd-b0a0-4604-9bea-475e91a9dc82",
                "payment_order_conciliation_batch_status": "open",
                "payment_order_conciliation_batch_type": "variable_amount",
                "account_key": "uuid",
                "total_amount": 0,
                "conciliated_amount": 0,
                "total_payment_orders": 0,
                "conciliated_payment_orders": 0,
                "reference_date": "2025-06-13",
                "created_at": "2025-06-10T20:30:23.459Z"
            }
        ]
    }
}

Webhook Body Params

Campo	Tipo	Descrição	Caracteres
webhook_type *	string	Tipo do evento do webhook (baas.automatic_pix.payment_order_conciliation_batch.creation).	100
webhook_datetime *	string	Data e hora que o webhook foi gerado (formato ISO 8601).	-
data *	Object	Objeto contendo detalhes dos lotes de conciliação.	Objeto data

---

Objeto data

Campo	Tipo	Descrição	Caracteres
payment_order_conciliation_batches *	array	Lista de lotes de conciliação criados.	Array payment_order_conciliation_batches

Array payment_order_conciliation_batches

Campo	Tipo	Descrição	Caracteres
payment_order_conciliation_batch_key	string	Chave única do lote de conciliação.	36
payment_order_conciliation_batch_status	string	Status do lote de conciliação (open).	-
payment_order_conciliation_batch_type	string	Tipo do lote de conciliação (fixed_amount, variable_amount).	-
account_key	uuidv4	Chave de identificação da conta associada ao lote.	36
total_amount	number	Valor total do lote de conciliação.	-
conciliated_amount	number	Valor total conciliado no lote.	-
total_payment_orders	number	Número total de ordens de pagamento no lote.	-
conciliated_payment_orders	number	Número de ordens de pagamento conciliadas no lote.	-
reference_date	string	Data de referência do lote (formato YYYY-MM-DD).	10
created_at	string	Data de criação do lote (formato ISO 8601).	-