通过密钥查询钱包条目

通过密钥查询钱包条目将返回特定条目的完整详情，包括所有相关的账单项目。

Request

ENDPOINT

/wallet/WALLET_KEY/wallet_entry/WALLET_ENTRY_KEY

MÉTODO

GET

路径参数

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

Response

STATUS

200

Response Body：钱包条目详情

{
  "wallet_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "wallet_entry_amount": 150.00,
  "wallet_entry_settlement_key": "cc8fb19b-d1e4-4ce6-ad4c-61e0609a8f8d",
  "wallet_entry_type": "revolving_credit",
  "wallet_entry_status": "concluded",
  "invoice_items": [
    {
      "invoice_item_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "invoice_key": "f2cad6b4-2a68-9572-99a7-2849c8d6ecf8",
      "wallet_entry_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "payment_instrument_entry_key": null,
      "installment_number": 1,
      "invoice_description": "Crédito rotativo - Taxa de juros",
      "amount": 150.00,
      "used_limit": 150.00,
      "invoice_item_status": "concluded",
      "invoice_item_due_date": "2024-02-15",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

响应体参数

字段	类型	描述	字符数
wallet_entry_key *	uuidv4	uuid v4 格式的条目唯一识别密钥	36
wallet_entry_amount *	float	条目金额	-
wallet_entry_settlement_key *	string	条目的清算密钥	-
wallet_entry_type *	string	钱包条目类型	wallet_entry_type 枚举值
wallet_entry_status *	string	钱包条目状态	wallet_entry_status 枚举值
invoice_items *	object array	相关账单项目	invoice_item 对象
created_at *	string	创建日期（ISO 8601 UTC 格式）	-

invoice_item 对象

字段	类型	描述	字符数
invoice_item_key *	uuidv4	uuid v4 格式的账单项目唯一识别密钥	36
invoice_key *	uuidv4	uuid v4 格式的账单唯一识别密钥	36
wallet_entry_key	uuidv4	uuid v4 格式的钱包条目唯一识别密钥	36
payment_instrument_entry_key	uuidv4	uuid v4 格式的支付工具条目唯一识别密钥	36
installment_number *	integer	分期期数	-
invoice_description *	string	账单项目描述	-
amount *	float	项目金额	-
used_limit *	float	已用额度	-
invoice_item_status *	string	账单项目状态	invoice_item_status 枚举值
invoice_item_due_date *	string	项目到期日（YYYY-MM-DD 格式）	10
created_at *	string	创建日期（ISO 8601 UTC 格式）	-

wallet_entry_type 枚举值

枚举值	描述
revolving_credit	循环信用
payroll_withdraw	工资提款
payroll_overdue	工资逾期

钱包条目类型

• revolving_credit：为客户提供的信用额度
• payroll_withdraw：因提取额度而产生的债务，每月从 INSS 中扣除
• payroll_overdue：因未支付账单而产生的债务，每月也从 INSS 中扣除

wallet_entry_status 枚举值

枚举值	描述
concluded	条目已完成

invoice_item_status 枚举值

枚举值	描述
concluded	项目已完成
canceled	项目已取消

错误响应

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	CIN000078	Not Found	Wallet entry with key: 8cb70dea-9fb0-4a68-9572-99a72849c8d6 was not found	Dívida da carteira com a chave: 8cb70dea-9fb0-4a68-9572-99a72849c8d6 não foi encontrado