Consultar lote de instruções

Retorna o detalhe de um lote previamente criado, com a lista de ocorrências geradas e o status individual de cada uma, junto com os dados básicos do boleto associado.

Request

ENDPOINT

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

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
batch_key	uuidv4	Chave do lote (retornada pelo POST de criação)	36

Response

STATUS

200

Response Body

{
  "batch_key": "f2d3e1b9-4a5c-46e7-8f12-9a8b7c6d5e4f",
  "requester_profile_key": "8217da98-3e26-4ca5-8b86-698bfa50b0df",
  "occurrence_type": "extension",
  "occurrence_quantity": 2,
  "accepted_quantity": 2,
  "created_at": "2026-06-09T17:08:33Z",
  "items": [
    {
      "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5",
      "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
      "request_control_key": "c86d8902-a5ae-4d1f-8872-e6fea1268aab",
      "occurrence_type": "extension",
      "payer_name": "Global Tech",
      "payer_document": "12345678000195",
      "amount": 5000.00,
      "our_number": "123456789",
      "requester_occurrence_status": "accepted",
      "registration_institution_occurrence_status": "submitted",
      "created_at": "2026-06-09T17:08:33Z"
    }
  ]
}

Response Body Params

Campo	Tipo	Descrição
batch_key *	uuidv4	Chave do lote
requester_profile_key *	uuidv4	Chave da carteira dona do lote
occurrence_type *	string	Tipo de instrução do lote
occurrence_quantity *	integer	Quantidade total de itens enviados no lote
accepted_quantity *	integer	Quantidade de itens aceitos no lote
created_at *	string	Data/hora UTC de criação do lote (ISO 8601 com sufixo Z)
items *	array	Lista de ocorrências geradas pelo lote. Veja Objeto item

Objeto item

Campo	Tipo	Descrição
bank_slip_key *	uuidv4	Chave do boleto da ocorrência
occurrence_key *	uuidv4	Chave única da ocorrência criada
request_control_key *	string	Chave de controle informada pelo cliente para o item
occurrence_type *	string	Tipo de instrução
payer_name	string	Nome do pagador do boleto
payer_document	string	Documento do pagador
amount	float	Valor base do boleto
our_number	string	Nosso número do boleto
requester_occurrence_status	string	Status da ocorrência do ponto de vista do solicitante (ex.: accepted, rejected)
registration_institution_occurrence_status	string	Status do processamento na instituição registradora (ex.: submitted, confirmed)
created_at *	string	Data/hora UTC de criação da ocorrência (ISO 8601 com sufixo Z)

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (pt-br) translation
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada

Atenção!

Quando o batch_key não existe ou não pertence à requester_profile_key informada, a API retorna o mesmo BKS000013 ("Carteira não encontrada"). Verifique se o batch_key foi criado sob a carteira utilizada na consulta.