跳到主要内容

获取 CNAB 文件

列出 CNAB 文件​

返回基金类别下某个 boleto 档案的 CNAB 文件（与银行交换的汇款/回执文件）的分页列表。

Request​

ENDPOINT
/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/cnab_files
METHOD
GET

Path Params​

参数描述
fund_class_key基金类别的键。若不存在则返回 404（NotFoundFundClass）。
bankslip_profile_keyboleto 档案的键，必须属于该基金类别。若未找到则返回 404（NotFoundBankslipConfiguration）。

Query Params​

所有参数均为可选。

参数类型描述
initial_datedate筛选 cnab_date 大于或等于该日期的文件（YYYY-MM-DD）。
final_datedate筛选 cnab_date 小于或等于该日期的文件（YYYY-MM-DD）。
cnab_typestring按文件类型筛选（参见 CNAB 类型）。
limitint每页条目数，取值范围为 0 到 20。默认值：10。
pageint页码（从零开始）。默认值：0。

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

Response​

Response Body
Response Body
{
    "data": [
        {
            "cnab_file_key": "79f21d3e-ed99-413c-8e05-39cf84fbab7c",
            "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"
                    }
                }
            },
            "cnab_date": "2025-07-30",
            "type": "return",
            "status": "completed",
            "download_filename": "cnab-retorno-2025-07-30-79f21d3e.ret",
            "url": "https://s3.amazonaws.com/...",
            "external_cnab_file_key": "e8b5e962-eb5f-4b9d-8d2b-70cd6d3d5252",
            "number_of_occurrences": 6
        },
        {
            "cnab_file_key": "ff7aaa47-a901-4f66-98d7-46f76ca4fa16",
            "bankslip_profile": {
                "bankslip_profile_key": "e0771a02-4f3e-4162-a468-a872fc6975e4",
                "bankslip_profile_code": "329-09-0001-0000000",
                "bankslip_profile_number": 9,
                "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"
                    }
                }
            },
            "cnab_date": "2025-07-30",
            "type": "external_return",
            "status": "completed",
            "download_filename": "cnab-retorno-2025-07-30-ff7aaa47.ret",
            "url": "https://s3.amazonaws.com/...",
            "external_cnab_file_key": "d3b1f7c4-9e2a-4f6b-8c1d-5a7e9b3f2c8e",
            "number_of_occurrences": 3,
            "bankslip_expenses": [
                {
                    "bankslip_expense_key": "4d727b05-00df-454e-93e3-160ec9ee596c",
                    "type": "fee_or_costs.payment",
                    "number_of_expenses": 3,
                    "total_value": 2.25,
                    "status": "completed"
                }
            ]
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true
}

分页对象​

字段类型描述
dataarrayCNAB File 对象列表
limitint每页获取的对象数量上限
pageint获取的页码
is_last_pageboolean指示获取的页面是否为最后一页

CNAB File​

字段类型描述
cnab_file_keystringCNAB 文件的唯一标识符。
bankslip_profileobject关联的 boleto 档案（参见 Bankslip Profile）。
cnab_datedateCNAB 文件的日期。
typestring文件类型（参见 CNAB 类型）。
statusstring文件状态（参见 CNAB 状态）。
download_filenamestring下载文件时使用的文件名。
urlstring用于下载文件的预签名 URL，有效期为 1 小时。若无法生成则省略。
external_cnab_file_keystring外部 CNAB 文件的标识符。仅当文件具有该值时出现。
headerstring文件的 header。仅当文件具有该值时出现。
trailerstring文件的 trailer。仅当文件具有该值时出现。
number_of_occurrencesint文件中的记录数。仅当文件具有该值时出现。
expectationobject文件的预期数据。仅当文件具有该值时出现。
bankslip_expensesarrayBankslip Expense 对象列表。仅当文件有关联费用时出现。

Bankslip Expense​

字段类型描述
bankslip_expense_keystring费用的唯一标识符。
typestring费用类型。
number_of_expensesint汇总的费用数量。
total_valuenumber费用总额。
statusstring费用状态。

CNAB 类型​

枚举值描述
return回执文件
external_return外部回执文件
remittance汇款文件
external_remittance外部汇款文件

CNAB 状态​

枚举值描述
created已创建
pending_processing待处理
completed已完成
canceled已取消