跳到主要内容

获取 Boleto 配置

列出 Boleto 配置​

返回某一基金类别下某个收款组合的 Boleto 配置分页列表。该基金必须属于已认证的管理人，或已关联到已认证的顾问。

Request​

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-api由集成团队开通

各主机的 Base URL：环境（主机）。

ENDPOINT
/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslip_configurations
MÉTODO
GET

Path Params​

参数描述
fund_class_key基金类别的 key。不存在时返回 404（BSC000006）。
bankslip_profile_key收款组合的 key，必须属于该基金类别。未找到时返回 404（BSC000007）。

Query Params​

所有参数均为可选。

参数类型描述
issuer_typestring按签发方类型筛选（见 签发方类型）。未知值返回错误 BSC000023。
limitint每页条目数，取值 0 到 30。默认：10。
pageint页码（从零开始）。默认：0。

当 is_last_page 为 false 时，请请求下一 page 以获取其余结果。

Response​

Response Body
Response Body
{
    "data": [
        {
            "bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
            "bankslip_profile": {
                "bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
                "bankslip_profile_code": "329-09-0001-0000000",
                "bankslip_profile_number": 9,
                "bankslip_provider": "qi_scd",
                "additional_information": {
                    "requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
                },
                "internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
                "fund_class": {
                    "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                    "document_number": "00.000.000/0001-01",
                    "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                    "manager": {
                        "name": "GESTÃO DE RECURSOS",
                        "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                        "document_number": "00.100.100/0001-00"
                    }
                }
            },
            "bankslip_issuer_type": "manager",
            "delay": 0,
            "our_number_range": {
                "our_number_range_initial": 1,
                "our_number_range_final": 99999
            }
        },
        {
            "bankslip_configuration_key": "9c47d1a8-3f2e-4b6d-8a1c-5e7f9b3d2c80",
            "bankslip_profile": {
                "bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
                "bankslip_profile_code": "329-09-0001-0000000",
                "bankslip_profile_number": 9,
                "bankslip_provider": "qi_scd",
                "additional_information": {
                    "requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
                },
                "internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
                "fund_class": {
                    "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                    "document_number": "00.000.000/0001-01",
                    "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                    "manager": {
                        "name": "GESTÃO DE RECURSOS",
                        "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                        "document_number": "00.100.100/0001-00"
                    }
                }
            },
            "bankslip_issuer_type": "internal",
            "delay": 1
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true,
    "elapsed_time_ms": 12.34
}

分页对象​

字段类型描述
dataarrayBankslip Configuration 对象列表
limitint每页获取的对象数量上限
pageint所获取的页码
is_last_pageboolean指示所获取的页是否为最后一页
elapsed_time_msnumber服务器端查询执行时间，单位为毫秒

Bankslip Configuration​

字段类型描述
bankslip_configuration_keystringBoleto 配置的唯一标识。
bankslip_profileobject关联的收款组合（见 Bankslip Profile）。
bankslip_issuer_typestringBoleto 签发方类型（见 签发方类型）。
delayint为 Boleto 签发配置的延迟。
our_number_rangeobject分配给该配置的"我方编号"（nosso número）区间（见 Our Number Range）。仅当配置已分配区间时返回。

Our Number Range​

字段类型描述
our_number_range_initialint"我方编号"区间的起始值。
our_number_range_finalint"我方编号"区间的结束值。

签发方类型​

枚举值描述
internal内部
manager管理人
consultant顾问

错误​

状态码代码触发条件
404BSC000007该基金中不存在此收款组合。
400BSC000023issuer_type 为未知值。
404BSC000006该 fund_class_key 不存在。
403BSC000036该基金不属于您的角色。

认证、权限和主机相关错误：参见 API 错误。