Consultar Dados de um Lote de Pagamentos

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

{
  "conciliation_batch_key": "a1b2c3d4-e5f6-7890-ghij-1234567890kl",
  "conciliation_status": "completed",
  "creation_date": "2023-10-05",
  "total_amount": 1000.50,
  "currency": "BRL",
  "number_of_orders": 15,
  "details": [
    {
      "order_key": "1234abcd-5678-efgh-9101-112131415161",
      "status": "processed",
      "amount": 150.75,
      "recipient_name": "Maria Silva"
    }
  ]
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
conciliation_batch_key	uuidv4	Identificador único do lote de conciliação.	36
conciliation_status	string	Status da conciliação (completed, pending, etc.).	30
creation_date	string	Data de criação do lote de conciliação (formato ISO 8601).	10
total_amount	number	Valor total da conciliação em reais (R$).	-
currency	string	Moeda utilizada na conciliação.	3
number_of_orders	integer	Número total de ordens de pagamento no lote.	-
details	array	Lista de detalhes das ordens de pagamento.	Array details

---

Array details

Campo	Tipo	Descrição	Caracteres
order_key	uuidv4	Identificador único da ordem de pagamento.	36
status	string	Status da ordem de pagamento (processed, pending, etc.).	30
amount	number	Valor da ordem de pagamento em reais (R$).	-
recipient_name	string	Nome do destinatário da ordem de pagamento.	50

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.