Listar lotes de instruções

Lista, de forma paginada, os lotes de instruções criados para uma carteira, com filtros opcionais por tipo de instrução e intervalo de datas.

Request

ENDPOINT

/v2/bank_slip/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/occurrence_batches

MÉTODO

GET

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta, no formato uuid v4	36
requester_profile_key	uuidv4	Chave única de identificação da carteira, no formato uuid v4	36

Query Parameters

Campo	Tipo	Descrição
page	integer	Página da consulta (padrão 1)
page_size	integer	Quantidade de lotes por página (padrão 20, máximo 100)
occurrence_type	string	Filtra pelo tipo de instrução do lote. Aceita os mesmos enumeradores do POST de criação
from_date	string	Data inicial, inclusiva, no formato YYYY-MM-DD. Filtra sobre o created_at do lote
to_date	string	Data final, inclusiva, no formato YYYY-MM-DD. Filtra sobre o created_at do lote

Response

STATUS

200

Response Body

{
  "data": [
    {
      "batch_key": "f2d3e1b9-4a5c-46e7-8f12-9a8b7c6d5e4f",
      "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f",
      "requester_profile_key": "8217da98-3e26-4ca5-8b86-698bfa50b0df",
      "occurrence_type": "extension",
      "occurrence_quantity": 14,
      "accepted_quantity": 14,
      "created_at": "2026-06-09T17:08:33Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total": 1
  }
}

Response Body Params

Campo	Tipo	Descrição
data *	array	Lista de lotes da página atual
data[].batch_key *	uuidv4	Chave do lote
data[].request_control_key *	string	Chave de controle informada pelo cliente na criação do lote
data[].requester_profile_key *	uuidv4	Chave da carteira dona do lote
data[].occurrence_type *	string	Tipo de instrução do lote
data[].occurrence_quantity *	integer	Quantidade total de itens enviados no lote
data[].accepted_quantity *	integer	Quantidade de itens aceitos no lote
data[].created_at *	string	Data/hora UTC de criação do lote (ISO 8601 com sufixo Z)
pagination *	object	Metadados de paginação
pagination.page *	integer	Página atual
pagination.page_size *	integer	Tamanho da página
pagination.total *	integer	Quantidade total de lotes que atendem aos filtros

Error Response

STATUS

4xx

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (pt-br) translation
400	QIT000001	Bad Request	Schema Error	Schema Inválido
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada