查询钱包票据（Boleto）

查询钱包票据将返回与钱包关联的银行票据信息，包括条形码和可键入行。

注意

钱包票据仅在第一张账单结账后才会生成。

Request

ENDPOINT

/v2/invoice/wallet/WALLET_KEY/wallet_bank_slip

MÉTODO

GET

路径参数

字段	类型	描述	字符数
wallet_key	uuidv4	UUID v4 格式的钱包唯一密钥	36

Response

STATUS

200

Response Body：票据详情

{
  "wallet_bank_slip_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "wallet_bank_slip_status": "accepted",
  "bank_slip_amount": 150.00,
  "bank_slip_due_date": "2024-02-15",
  "bank_slip_data": {
    "barcode": "32991090000000150001234567890123456789012345",
    "digitable_line": "32991234567890123456789012345678901234567890123"
  }
}

响应体参数

字段	类型	描述	字符数
wallet_bank_slip_key *	uuidv4	uuid v4 格式的钱包票据唯一识别密钥	36
wallet_bank_slip_status *	string	票据状态	wallet_bank_slip_status 枚举值
bank_slip_amount *	float	票据金额	-
bank_slip_due_date *	string	票据到期日（YYYY-MM-DD 格式）	10
bank_slip_data *	object	包含条形码和可键入行的票据数据	bank_slip_data 对象

bank_slip_data 对象

字段	类型	描述	字符数
barcode *	string	票据条形码	44
digitable_line *	string	票据可键入行	47

wallet_bank_slip_status 枚举值

枚举值	描述
accepted	票据已接受，等待登记确认
registered	票据已登记，可供支付

错误响应

STATUS

4xx

Response Body: Error

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

HTTP 代码 status	QI 代码 code	标题 title	描述（英文） description	描述（葡文） translation
404	CIN000007	Wallet not Found	Wallet with key: abeca0d0-a09d-4b3b-a495-40b553422ced was not found	Carteira com a chave: abeca0d0-a09d-4b3b-a495-40b553422ced não foi encontrado
404	CIN000093	Not Found	Wallet bank slip was not found	Boleto da carteira não foi encontrado