跳到主要内容

通过密钥查询钱包

通过密钥查询钱包将返回特定钱包的完整详情，包括其账单配置和信用额度。

Request​

ENDPOINT
/wallet/WALLET_KEY
MÉTODO
GET

路径参数​

字段类型描述字符数
wallet_keyuuidv4钱包的唯一识别密钥36

Response​

STATUS
200
Response Body：钱包详情
{
  "request_control_key": "f7947b9d-9be3-49d8-aca2-4b3249e5fa65",
  "wallet_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "owner_person_key": "ecf87b4b-fa6e-49c0-a7f0-f2cad6b42d79",
  "owner_document_number": "12345678901",
  "invoice_configuration": {
    "closing_date_configuration": {
      "type": "fixed",
      "fixed_day": 15
    },
    "due_date_configuration": {
      "type": "fixed",
      "fixed_day": 20,
      "offset_months": 0
    },
    "invoice_payment_type": "bank_slip",
    "interest_base": "calendar_days",
    "monthly_interest_percentage": 2.0,
    "fine_percentage": 2.0
  },
  "wallet_status": "active",
  "wallet_type": "default",
  "wallet_limits": [
    {
      "wallet_limit_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "limit_type": "postpaid_credit_limit",
      "limit_amount": 5000.00,
      "used_limit": 0.00
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

响应体参数​

字段类型描述字符数
wallet_key *string钱包的唯一识别密钥36
owner_person_key *string钱包所有者的识别密钥36
owner_document_number *string钱包所有者的 CPF/CNPJ11-14
invoice_configuration *object钱包的账单配置invoice_configuration 对象
wallet_status *string钱包的当前状态wallet_status 枚举值
wallet_type *string钱包类型wallet_type 枚举值
wallet_limits *array钱包额度列表wallet_limits 对象
created_at *string创建日期（ISO 8601 UTC 格式）-

invoice_configuration 对象​

字段类型描述字符数
closing_date_configuration *object账单结账日配置closing_date_configuration 对象
due_date_configuration *object账单到期日配置due_date_configuration 对象
invoice_payment_type *string账单支付类型invoice_payment_type 枚举值
interest_basestring利息计算基础interest_base 枚举值
monthly_interest_percentagefloat逾期月利率（0-100）-
fine_percentagefloat逾期罚款比例（0-100）-
信息

注意：payroll 类型的钱包不包含 interest_base、monthly_interest_percentage 和 fine_percentage 字段。

closing_date_configuration 对象​

固定配置（type: "fixed"）​

字段类型描述字符数
type *string配置类型（必须为 "fixed"）-
fixed_day *integer每月固定结账日（1-27）-

基于规则的配置（type: "rule_based"）​

字段类型描述字符数
type *string配置类型（必须为 "rule_based"）-
rule *object日期计算规则rule 对象（closing_date_configuration）

rule 对象（closing_date_configuration）​

字段类型描述字符数
day_of_week *string星期几day_of_week 枚举值
occurrence *string当月第几次出现occurrence 枚举值
fallback_strategy *string非工作日策略fallback_strategy 枚举值

due_date_configuration 对象​

固定配置（type: "fixed"）​

字段类型描述字符数
type *string配置类型（必须为 "fixed"）-
offset_months *integer从结账日起的月份偏移量-
fixed_day *integer每月固定到期日（2-27）-

基于规则的配置（type: "rule_based"）​

字段类型描述字符数
type *string配置类型（必须为 "rule_based"）-
offset_months *integer从结账日起的月份偏移量-
rule *object日期计算规则rule 对象（due_date_configuration）

rule 对象（due_date_configuration）​

字段类型描述字符数
day_of_week *string星期几day_of_week 枚举值
occurrence *string当月第几次出现occurrence 枚举值
fallback_strategy *string非工作日策略fallback_strategy 枚举值

wallet_limits 对象​

字段类型描述字符数
limit_type *string额度类型limit_type 枚举值
limit_amount *float总额度金额-
used_limit *float已用额度金额-

wallet_status 枚举值​

枚举值描述
pending_analysis等待 KYC 分析的钱包
active已激活且可使用的钱包
rejected已拒绝的钱包

wallet_type 枚举值​

枚举值描述
default标准钱包
payroll薪资代扣卡钱包

limit_type 枚举值​

枚举值描述
postpaid_credit_limit后付费信用额度
payroll_withdraw_limit工资提款额度（工资/代扣）
薪资卡 Wallet 的额度

payroll 类型的钱包有两种不同的额度：

  • postpaid_credit_limit：用于消费和卡片交易的后付费信用额度
  • payroll_withdraw_limit：工资提款（工资/代扣）的专用额度，每月自动从客户工资中扣除

day_of_week 枚举值​

枚举值描述
monday星期一
tuesday星期二
wednesday星期三
thursday星期四
friday星期五
saturday星期六
sunday星期日

occurrence 枚举值​

枚举值描述
first第一次出现
second第二次出现
third第三次出现
fourth第四次出现
last最后一次出现

fallback_strategy 枚举值​

枚举值描述
next_business_day下一个工作日
previous_business_day上一个工作日
same_day当天

invoice_payment_type 枚举值​

枚举值描述
bank_slip银行票据（Boleto bancário）

interest_base 枚举值​

枚举值描述
calendar_days自然日

wallet_limits 对象​

字段类型描述字符数
wallet_limit_key *uuidv4UUID v4 格式的已更新额度唯一识别密钥36
limit_type *string额度类型limit_type 枚举值
limit_amount *float总额度金额-
used_limit *float已用额度金额-

limit_type 枚举值​

枚举值描述
postpaid_credit_limit后付费信用额度

错误响应​

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
404WLT000001Wallet Not FoundWallet with key 8cb70dea-9fb0-4a68-9572-99a72849c8d6 not foundCarteira com chave 8cb70dea-9fb0-4a68-9572-99a72849c8d6 não encontrada