Query Payment Batch Data by Account

Request

ENDPOINT

/account/ACCOUNT_KEY/payment_order_conciliation_batch/PAYMENT_ORDER_CONCILIATION_BATCH_KEY

METHOD

GET

Path Params

Field	Type	Description	Characters
ACCOUNT_KEY *	uuidv4	Unique account identification key.	36
PAYMENT_ORDER_CONCILIATION_BATCH_KEY*	uuidv4	Unique batch identification key.	36

Response

STATUS

200

Response Body

{
  "payment_order_conciliation_batch_status": "open",
  "payment_order_conciliation_batch_type": "fixed_amount",
  "total_amount": 1000.00,
  "conciliated_amount": 500.00,
  "total_payment_orders": 10,
  "conciliated_payment_orders": 5,
  "reference_date": "2025-06-13",
  "created_at": "2025-06-10T20:30:23.459Z"
}

Response Body Params

Field	Type	Description	Characters
payment_order_conciliation_batch_status	enumerator	Payment order conciliation batch status.	payment_order_conciliation_batch_status Enumerators
payment_order_conciliation_batch_type	enumerator	Payment order conciliation batch type.	payment_order_conciliation_batch_type Enumerators
total_amount	number	Total value of the conciliation batch in reais (R$).	-
conciliated_amount	number	Already conciliated value of the batch in reais (R$).	-
total_payment_orders	integer	Total number of payment orders in the batch.	-
conciliated_payment_orders	integer	Number of payment orders already conciliated in the batch.	-
reference_date	string	Batch reference date (ISO 8601 format, e.g., "2025-06-13").	10
created_at	string	Batch creation date and time (ISO 8601 format).	-

payment_order_conciliation_batch_status Enumerators

Enumerator	Description
open	Open conciliation batch
closed	Closed conciliation batch
processing	Conciliation batch in processing
completed	Completed conciliation batch
cancelled	Cancelled conciliation batch

payment_order_conciliation_batch_type Enumerators

Enumerator	Description
fixed_amount	Fixed amount conciliation batch
variable_amount	Variable amount conciliation batch

STATUS

4XX

Response Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "codigo"
}

HTTP Code	QI Code code	Title title	Description (eng) description	Description (ptbr) translation
400	QIT000002	Bad Request	Invalid request schema.	Erro no esquema da requisição.
404	APX000003	Conciliation Batch Not Found	Conciliation batch {conciliation_batch_key} not found.	Lote de conciliação {conciliation_batch_key} não encontrado.