跳到主要内容

列出账户钱包

钱包列表将返回符合请求中发送的查询参数的所有账户票据钱包。

Request​

ENDPOINT
/account/ACCOUNT_KEY/requester_profiles
MÉTODO
GET

Path parameters​

字段类型描述字符数
account_keyuuidv4账户唯一标识键，uuid v4 格式36

Query parameters​

字段类型描述字符数
request_control_keyuuidv4请求唯一标识键，uuid v4 格式36
requester_profile_keyuuidv4票据钱包唯一标识键，uuid v4 格式36
requester_profile_codestring钱包唯一识别码19
pageinteger页码-
page_sizeinteger每页大小-

Response​

STATUS
200
Response Body
{
  "data": [
    {
      "requester_profile_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
      "requester_profile_code": "329-04-2338-2625918",
      "request_control_key": "0868a24b-4a69-4138-ac4d-ecaeddf0005f",
      "account_key": "0494902f-b21c-4ae6-b37e-854cfe883402",
      "requester_profile_status": "pending",
      "configuration_data": {
        "max_payment_days": 1,
        "protest_settings": {
          "days_to_protest": 0
        },
        "bankruptcy_protest_settings": {
          "days_to_bankruptcy_protest": 0
        },
        "write_off_settings": {
          "days_to_write_off": 0
        },
        "fine_settings": {
          "fine_type": "absolute",
          "fine_amount": 10,
          "days_to_fine": 0
        },
        "interest_settings": {
          "interest_type": "workdays_daily_amount",
          "interest_amount": 10,
          "days_to_interest": 0
        },
        "qr_code_settings": {
          "pix_key": "5df7a433-bd61-4f98-9515-df9aedc2980c",
          "qr_code_on_discharge_enabled": false
        },
        "cnab_settings": {
          "default_bank": "qi_scd",
          "preferred_layout": "400"
        }
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Parameters​

字段类型描述字符数
data *object array票据钱包列表Objeto requester_profile
pagination *object分页信息Objeto pagination

Objeto requester_profile​

字段类型描述字符数
requester_profile_key *uuidv4钱包唯一标识键，uuid v4 格式36
requester_profile_code *string钱包唯一识别码19
request_control_key *uuidv4客户使用的请求唯一标识键，uuid v4 格式36
account_key *uuidv4账户唯一标识键，uuid v4 格式36
requester_profile_status *string钱包状态Enumeradores requester_profile_status
configuration_data *object钱包默认配置Objeto configuration_data

Enumeradores requester_profile_status​

枚举值描述
pending钱包已接受，等待确认
opened钱包已开启

Objeto pagination​

字段类型描述字符数
current_page *integer当前页码-
rows_per_page *integer每页记录数-

Objeto configuration_data​

字段类型描述字符数
max_payment_days *integer票据到期后可供付款的最大日历天数（最多 365 天）-
write_off_settingsobject默认核销配置Objeto write_off_settings
protest_settingsobject默认抗议配置Objeto protest_settings
bankruptcy_protest_settingsobject默认破产抗议配置Objeto bankruptcy_protest_settings
fine_settingsobject默认罚款配置Objeto fine_setings
interest_settingsobject默认利息配置Objeto interest_settings
qr_code_settingsobjectPIX QR Code 默认配置（用于 bolePix）Objeto qr_code_settings
cnab_settingsobjectCNAB 文件默认配置Objeto cnab_settings

Objeto write_off_settings​

字段类型描述字符数
days_to_write_off *integer到期后自动核销票据的天数-

Objeto protest_settings​

字段类型描述字符数
days_to_protest *integer到期后自动抗议票据的天数-

Objeto bankruptcy_protest_settings​

字段类型描述字符数
days_to_bankruptcy_protest *integer到期后自动启动破产抗议流程的天数-

Objeto fine_settings​

选项 1：绝对值罚款（fine_type=absolute）
字段类型描述字符数
fine_type *string罚款类型Enumeradores fine_type
fine_amount *float罚款绝对值-
days_to_fine *integer到期后开始收取罚款的天数-
选项 2：百分比罚款（fine_type=percentage）
字段类型描述字符数
fine_type *string罚款类型Enumeradores fine_type
fine_percentage *integer罚款百分比值，1 到 100-
days_to_fine *integer到期后开始收取罚款的天数-

Enumeradores fine_type​

枚举值描述
absolute绝对值
percentage百分比值

Objeto interest_settings​

选项 1：使用绝对值利息（interest_type=calendar_days_daily_amount 或 interest_type=workdays_daily_amount）
字段类型描述字符数
interest_type *string利息类型Enumeradores interest_type
interest_amount *float按指定时间单位（工作日或日历日）收取的金额-
days_to_interest *integer到期后开始收取利息的天数-
选项 2：使用百分比利息（interest_type=calendar_days_monthly_percentage）
字段类型描述字符数
interest_type *string利息类型Enumeradores interest_type
interest_percentage *integer按指定时间单位（工作日或日历日）收取的百分比-
days_to_interest *integer到期后开始收取利息的天数-

Enumeradores interest_type​

枚举值描述
calendar_days_daily_amount基于日历日的每日金额
workdays_daily_amount基于工作日的每日金额
calendar_days_monthly_percentage基于日历日按月收取的利息百分比

Objeto qr_code_settings​

字段类型描述字符数
pix_key *uuidv4随机类型的 PIX 密钥36
qr_code_on_discharge_enabled *boolean确定 QR Code 信息是否包含在退款文件（CNAB）中-

Objeto cnab_settings​

字段类型描述字符数
default_bankstring处理 CNAB 文件的默认银行布局Enumeradores default_bank
preferred_layoutstringCNAB 文件首选布局Enumeradores preferred_layout

Enumeradores default_bank​

枚举值描述
santanderBanco Santander
itauBanco Itaú
bradescoBanco Bradesco
qi_scdQI SCD

Enumeradores preferred_layout​

枚举值描述
400CNAB 400 布局
240CNAB 240 布局

Error Response​

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
400QIT000001Bad RequestSchema ErrorSchema Inválido
404BKS000006Not FoundThe source account key was not found.A chave da conta de origem não foi encontrada.
400BKS000007Bad RequestIt was not possible to consult the source account at this time. Please try again in a few minutes.Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400BKS000008Bad RequestThe source account is closed.A conta de origem está fechada.
400BKS000009Bad RequestThe source account is blocked.A conta de origem está bloqueada.
400BKS000012Bad RequestInvalid integer value for page or size query string parameters.Valor inválido para parâmetros de página ou tamanho de página.
404BKS000013Not FoundRequester profile not foundCarteira não encontrada
400BKS000025Bad RequestInvalid bank slip status.Status de boleto inválido.