Consultar Lotes de Pagamentos por Requester

Request

ENDPOINT

/payment_order_conciliation_batches

MÉTODO

GET

Query Params

Campo	Tipo	Descrição	Obrigatório
payment_order_conciliation_batch_status	enumerator	Filtro por status do lote de conciliação.	Não
payment_order_conciliation_batch_type	enumerator	Filtro por tipo do lote de conciliação.	Não
page	integer	Número da página para paginação (padrão: 1).	Não
page_size	integer	Tamanho da página para paginação (padrão: 25).	Não
from_date	string	Data inicial para filtro (formato ISO 8601, e.g., "2025-06-01").	Não
to_date	string	Data final para filtro (formato ISO 8601, e.g., "2025-06-30").	Não

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

Campo	Tipo	Descrição	Caracteres
payment_order_conciliation_batches	array	Lista de lotes de conciliação de ordens de pagamento.	Array payment_order_conciliation_batches
pagination	object	Informações de paginação da consulta.	Objeto pagination

Array payment_order_conciliation_batches

Campo	Tipo	Descrição	Caracteres
payment_order_conciliation_batch_key	uuidv4	Identificador único do lote de conciliação.	36
payment_order_conciliation_batch_status	enumerator	Status do lote de conciliação de ordens de pagamento.	Enumeradores payment_order_conciliation_batch_status
payment_order_conciliation_batch_type	enumerator	Tipo do lote de conciliação de ordens de pagamento.	Enumeradores payment_order_conciliation_batch_type
account_key	uuidv4	Chave única de identificação da conta.	36
total_amount	number	Valor total do lote de conciliação em reais (R$).	-
conciliated_amount	number	Valor já conciliado do lote em reais (R$).	-
total_payment_orders	integer	Número total de ordens de pagamento no lote.	-
conciliated_payment_orders	integer	Número de ordens de pagamento já conciliadas no lote.	-
reference_date	string	Data de referência do lote (formato ISO 8601, e.g., "2025-06-13").	10
created_at	string	Data e hora de criação do lote (formato ISO 8601).	-

Objeto pagination

Campo	Tipo	Descrição	Caracteres
page	integer	Página atual da consulta.	-
page_size	integer	Tamanho da página (número de itens por página).	-
number_of_pages	integer	Número total de páginas disponíveis.	-

Enumeradores payment_order_conciliation_batch_status

Enumerador	Descrição
open	Lote de conciliação aberto
closed	Lote de conciliação fechado
processing	Lote de conciliação em processamento
completed	Lote de conciliação concluído
cancelled	Lote de conciliação cancelado

Enumeradores payment_order_conciliation_batch_type

Enumerador	Descrição
fixed_amount	Lote de conciliação de valor fixo
variable_amount	Lote de conciliação de valor variável

STATUS

4XX

Response Error

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

Código HTTP	Código QI code	Título title	Descrição (eng) description	Descrição (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.