Query instruction batch

Returns the detail of a previously created batch, with the list of generated occurrences and the individual status of each one, along with basic data of the related bank slip.

Request

ENDPOINT

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

METHOD

GET

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key, in uuid v4 format	36
requester_profile_key	uuidv4	Unique wallet identification key, in uuid v4 format	36
batch_key	uuidv4	Batch key (returned by the create POST)	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

Field	Type	Description
batch_key *	uuidv4	Batch key
requester_profile_key *	uuidv4	Key of the wallet that owns the batch
occurrence_type *	string	Instruction type of the batch
occurrence_quantity *	integer	Total number of items sent in the batch
accepted_quantity *	integer	Number of items accepted in the batch
created_at *	string	UTC creation date/time of the batch (ISO 8601 with Z suffix)
items *	array	List of occurrences generated by the batch. See item object

item object

Field	Type	Description
bank_slip_key *	uuidv4	Bank slip key of the occurrence
occurrence_key *	uuidv4	Unique key of the created occurrence
request_control_key *	string	Item's client-provided control key
occurrence_type *	string	Instruction type
payer_name	string	Bank slip payer name
payer_document	string	Payer document
amount	float	Bank slip base amount
our_number	string	Bank slip "our number"
requester_occurrence_status	string	Occurrence status from the requester's perspective (e.g. accepted, rejected)
registration_institution_occurrence_status	string	Occurrence status at the registration institution (e.g. submitted, confirmed)
created_at *	string	UTC creation date/time of the occurrence (ISO 8601 with Z suffix)

Error Response

STATUS

4xx

Response Body: Error

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

HTTP code status	QI code code	Title title	Description (eng) description	Description (pt-br) translation
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada

Attention!

When the batch_key does not exist or does not belong to the informed requester_profile_key, the API returns the same BKS000013 ("Requester profile not found"). Check whether the batch_key was created under the wallet used in the query.