查询指令批次

返回先前创建批次的详情，包括所生成事件的列表、每个事件的状态以及对应 Boleto 的基本信息。

Request

ENDPOINT

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

MÉTODO

GET

路径参数

字段	类型	描述	字符数
account_key	uuidv4	账户唯一识别密钥，格式为 uuid v4	36
requester_profile_key	uuidv4	钱包唯一识别密钥，格式为 uuid v4	36
batch_key	uuidv4	批次密钥（由创建 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

字段	类型	描述
batch_key *	uuidv4	批次密钥
requester_profile_key *	uuidv4	持有该批次的钱包密钥
occurrence_type *	string	批次的指令类型
occurrence_quantity *	integer	批次中发送的总项目数
accepted_quantity *	integer	批次中被接受的项目数
created_at *	string	批次的 UTC 创建时间（ISO 8601，含 Z 后缀）
items *	array	批次生成的事件列表。详见 item 对象

item 对象

字段	类型	描述
bank_slip_key *	uuidv4	事件对应的 Boleto 密钥
occurrence_key *	uuidv4	创建事件的唯一密钥
request_control_key *	string	客户为该项目提供的控制密钥
occurrence_type *	string	指令类型
payer_name	string	Boleto 付款人名称
payer_document	string	付款人证件号
amount	float	Boleto 基础金额
our_number	string	Boleto 的 "our number"
requester_occurrence_status	string	请求方视角的事件状态（例如 accepted、rejected）
registration_institution_occurrence_status	string	注册机构侧的事件处理状态（例如 submitted、confirmed）
created_at *	string	事件的 UTC 创建时间（ISO 8601，含 Z 后缀）

Error Response

STATUS

4xx

Response Body: Error

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

HTTP 代码 status	QI 代码 code	标题 title	描述（英） description	描述（葡） translation
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada

注意！

当 batch_key 不存在或不属于所提供的 requester_profile_key 时，API 同样返回 BKS000013（"Carteira não encontrada"）。请确认 batch_key 是否在所查询的钱包下创建。