Query Payment Batches by Requester

Request

ENDPOINT

/payment_order_conciliation_batches

METHOD

GET

Query Params

Field	Type	Description	Required
payment_order_conciliation_batch_status	enumerator	Filter by conciliation batch status.	No
payment_order_conciliation_batch_type	enumerator	Filter by conciliation batch type.	No
page	integer	Page number for pagination (default: 1).	No
page_size	integer	Page size for pagination (default: 25).	No
from_date	string	Start date for filter (ISO 8601 format, e.g., "2025-06-01").	No
to_date	string	End date for filter (ISO 8601 format, e.g., "2025-06-30").	No

Response

STATUS

200

Response Body

{
    "payment_order_conciliation_batches": [
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "closed",
            "payment_order_conciliation_batch_type": "fixed_amount",
            "account_key": "9b9ae7b0-7292-4b0d-9131-0167525ab067",
            "total_amount": 1200,
            "conciliated_amount": 1200,
            "total_payment_orders": 12,
            "conciliated_payment_orders": 12,
            "reference_date": "2025-06-13",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "closed",
            "payment_order_conciliation_batch_type": "variable_amount",
            "account_key": "9b9ae7b0-7292-4b0d-9131-0167525ab067",
            "total_amount": 700,
            "conciliated_amount": 600,
            "total_payment_orders": 7,
            "conciliated_payment_orders": 6,
            "reference_date": "2025-06-13",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "open",
            "payment_order_conciliation_batch_type": "variable_amount",
            "account_key": "9b9ae7b0-7292-4b0d-9131-0167525ab067",
            "total_amount": 900,
            "conciliated_amount": 700,
            "total_payment_orders": 9,
            "conciliated_payment_orders": 7,
            "reference_date": "2025-06-17",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "closed",
            "payment_order_conciliation_batch_type": "fixed_amount",
            "account_key": "c24a0ac4-792c-494e-b887-6185e07a33a3",
            "total_amount": 800,
            "conciliated_amount": 800,
            "total_payment_orders": 8,
            "conciliated_payment_orders": 8,
            "reference_date": "2025-06-13",
            "created_at": "2025-06-10T20:30:23.459Z"
        },
        {
            "payment_order_conciliation_batch_key": "98fc62fd-b0a0-4604-9bea-475e91a9dc82",
            "payment_order_conciliation_batch_status": "open",
            "payment_order_conciliation_batch_type": "variable_amount",
            "account_key": "c24a0ac4-792c-494e-b887-6185e07a33a3",
            "total_amount": 1000,
            "conciliated_amount": 500,
            "total_payment_orders": 10,
            "conciliated_payment_orders": 5,
            "reference_date": "2025-06-17",
            "created_at": "2025-06-10T20:30:23.459Z"
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 25,
        "number_of_pages": 1
    }
}

Response Body Params

Field	Type	Description	Characters
payment_order_conciliation_batches	array	List of payment order conciliation batches.	Array payment_order_conciliation_batches
pagination	object	Query pagination information.	Object pagination

Array payment_order_conciliation_batches

Field	Type	Description	Characters
payment_order_conciliation_batch_key	uuidv4	Unique identifier of the conciliation batch.	36
payment_order_conciliation_batch_status	enumerator	Status of the payment order conciliation batch.	Enumerators payment_order_conciliation_batch_status
payment_order_conciliation_batch_type	enumerator	Type of the payment order conciliation batch.	Enumerators payment_order_conciliation_batch_type
account_key	uuidv4	Unique account identification key.	36
total_amount	number	Total amount of the conciliation batch in Brazilian reais (R$).	-
conciliated_amount	number	Already conciliated amount of the batch in Brazilian 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	Reference date of the batch (ISO 8601 format, e.g., "2025-06-13").	10
created_at	string	Batch creation date and time (ISO 8601 format).	-

Object pagination

Field	Type	Description	Characters
page	integer	Current page of the query.	-
page_size	integer	Page size (number of items per page).	-
number_of_pages	integer	Total number of available pages.	-

Enumerators payment_order_conciliation_batch_status

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

Enumerators payment_order_conciliation_batch_type

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 not found.	Lote de conciliação não encontrado.