Consultar Dados de um Lote de Pagamentos por conta

Request

ENDPOINT

/account/ACCOUNT_KEY/payment_order_conciliation_batch/PAYMENT_ORDER_CONCILIATION_BATCH_KEY

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
ACCOUNT_KEY *	uuidv4	Chave única de identificação da conta.	36
PAYMENT_ORDER_CONCILIATION_BATCH_KEY*	uuidv4	Chave única de identificação do lote.	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

Campo	Tipo	Descrição	Caracteres
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
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).	-

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