获取收款组合

---

列出收款组合

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

Request

适用范围

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

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

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profiles

MÉTODO

GET

Path Params

参数	描述
fund_class_key	基金类别的 key。不存在时返回 404（BSC000006）。

Query Params

所有参数均为可选。

参数	类型	描述
limit	int	每页条目数，取值 0 到 50。默认：10。
page	int	页码（从零开始）。默认：0。

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

Response

Response Body

Response Body

{
    "data": [
        {
            "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"
                }
            },
            "total_value": 12345.67,
            "total_overdue_value": 890.12
        },
        {
            "bankslip_profile_key": "e0771a02-4f3e-4162-a468-a872fc6975e4",
            "bankslip_profile_code": "329-09-0001-0000001",
            "bankslip_profile_number": 10,
            "bankslip_provider": "qi_scd",
            "additional_information": {
                "requester_profile_key": "cdec985f-e629-44ce-8511-a323f38bd63e"
            },
            "internal_account_key": "5e621ba2-b4ac-4ddd-9893-82d220e1577e",
            "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"
                }
            }
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true,
    "elapsed_time_ms": 12.34
}

分页对象

字段	类型	描述
data	array	Bankslip Profile 对象列表
limit	int	每页获取的对象数量上限
page	int	所获取的页码
is_last_page	boolean	指示所获取的页是否为最后一页
elapsed_time_ms	number	服务器端查询执行时间，单位为毫秒

Bankslip Profile

字段	类型	描述
bankslip_profile_key	string	收款组合的标识。
bankslip_profile_code	string	收款组合代码。
bankslip_profile_number	number	收款组合编号。
bankslip_provider	string	Boleto 服务提供方。
additional_information	object	收款组合的附加信息。
internal_account_key	string	关联的内部账户标识。
fund_class	object	表示基金类别的对象（见 Fund Class）。
total_value	number	该组合的未结总额。仅在定期计算组合余额后返回。
total_overdue_value	number	该组合的逾期总额。仅在定期计算组合余额后返回。

错误

状态码	代码	触发条件
404	BSC000006	该 fund_class_key 不存在。
403	BSC000036	该基金不属于您的角色。

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