Skip to main content

Payment Order Conciliation Batch Creation Webhook

Webhook notifications are essential for processing events about payment conciliation in Automatic Pix. This webhook informs about the creation of payment order conciliation batches.

Conciliation Batch Creation Webhook

This webhook is issued when a new payment order conciliation batch is created.

Attention!

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

Webhook Request Body

Request Body: Journey 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

FieldTypeDescriptionCharacters
webhook_type *stringWebhook event type (baas.automatic_pix.payment_order_conciliation_batch.creation).100
webhook_datetime *stringDate and time when the webhook was generated (ISO 8601 format).-
data *ObjectObject containing conciliation batch details.data Object

data Object

FieldTypeDescriptionCharacters
payment_order_conciliation_batches *arrayList of created conciliation batches.payment_order_conciliation_batches Array

payment_order_conciliation_batches Array

FieldTypeDescriptionCharacters
payment_order_conciliation_batch_keystringUnique key of the conciliation batch.36
payment_order_conciliation_batch_statusstringStatus of the conciliation batch (open).-
payment_order_conciliation_batch_typestringType of conciliation batch (fixed_amount, variable_amount).-
account_keyuuidv4Identification key of the account associated with the batch.36
total_amountnumberTotal amount of the conciliation batch.-
conciliated_amountnumberTotal conciliated amount in the batch.-
total_payment_ordersnumberTotal number of payment orders in the batch.-
conciliated_payment_ordersnumberNumber of conciliated payment orders in the batch.-
reference_datestringReference date of the batch (YYYY-MM-DD format).10
created_atstringCreation date of the batch (ISO 8601 format).-