跳到主要内容

获取 Boleto

Boleto 列表​

Request​

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

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

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

Query Params​

参数描述
limit每页条目数，取值 0 到 100。默认：10。
page页码（从零开始）。
borrower_document_number借款人的证件号（仅数字）。
assignor_document_number转让方的证件号（仅数字）。
participant_control_number参与方控制编号。
order_number合同编号。
our_numberBoleto 在银行中的"我方编号"（nosso número）。
statusBoleto 状态：created、pending_registration、registered、waiting_payment_confirmation、paid、paid_via_qr_code、rejected、written_off 或 registration_failed。
from_due_date到期日不早于该日期（YYYY-MM-DD）。
to_due_date到期日不晚于该日期（YYYY-MM-DD）。
bankslip_typeBoleto 类型：simple_collection 或 non_vinculated。
asset_key与 Boleto 关联的资产的 key。

Response​

Response Body
Response Body
{
    "data": [
        {
            "bankslip_key": "c9eb109c-800f-4cf5-b209-2119c9d77a72",
            "external_participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
            "bankslip_configuration": {
                "bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
                "bankslip_profile": {
                    "bankslip_profile_key": "5910d4a3-f5df-432a-902f-849a1a77cd86",
                    "bankslip_profile_code": "329-09-0001-4993010",
                    "bankslip_profile_number": 1,
                    "bankslip_provider": "qi_scd",
                    "additional_information": {
                        "external_beneficiary_key": "2666e7a3-0bd7-46fc-8f6b-725f2ef9b13f"
                    },
                    "internal_account_key": "6b5335ed-1380-4348-9520-8998ca6e388b",
                    "fund_class": {
                        "fund_class_key": "7f03069e-1854-4cee-8e59-a6a548976015",
                        "document_number": "11.222.333/0001-81",
                        "name": "Sample_Name",
                        "manager": {
                            "name": "Sample name",
                            "manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
                            "document_number": "11.222.333/0001-81"
                        }
                    }
                }
            },
            "due_date": "2024-02-17",
            "face_value": 629.33,
            "status": "pending_registration",
            "participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
            "borrower": {
                "document_number": "969.698.790-03",
                "name": "Tomador",
                "person_type": "natural_person",
                "address": {
                    "postal_code": "05425-020"
                }
            },
            "assignor": {
                "name": "Assignor LTDA",
                "document_number": "33.444.555/0001-81",
                "person_type": "legal_person"
            },
            "bankslip_type": "simple_collection",
            "collection_type": "standard",
            "delay": null,
            "occurrences": [
                {
                    "occurrence_key": "e9898e50-cd2b-492f-9201-7e5c5f231853",
                    "status": "pending_submission",
                    "type": "registration",
                    "occurrence_data": null
                }
            ],
            "settlement_instructions": [
                {
                    "settlement_instruction_key": "fe419363-bf04-4b3a-90bd-185618baa720",
                    "status": "pending_bankslip_payment",
                    "asset_type": "duplicata_mercantil",
                    "asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
                    "issue_date": "2025-01-17",
                    "maturity_date": "2026-09-17",
                    "face_value": 629.33,
                    "order_number": "49761-1"
                }
            ]
        },
        {
            "bankslip_key": "4584e60c-752f-479d-831a-50f09c2c7de2",
            "external_participant_control_number": "TBFBDWKTEWJ7UTR6CPL4BAE4P",
            "bankslip_configuration": {
                "bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
                "bankslip_profile": {
                    "bankslip_profile_key": "5910d4a3-f5df-432a-902f-849a1a77cd86",
                    "bankslip_profile_code": "329-09-0001-4993010",
                    "bankslip_profile_number": 1,
                    "bankslip_provider": "qi_scd",
                    "additional_information": {
                        "external_beneficiary_key": "2666e7a3-0bd7-46fc-8f6b-725f2ef9b13f"
                    },
                    "internal_account_key": "6b5335ed-1380-4348-9520-8998ca6e388b",
                    "fund_class": {
                        "fund_class_key": "7f03069e-1854-4cee-8e59-a6a548976015",
                        "document_number": "11.222.333/0001-81",
                        "name": "Sample_Name",
                        "manager": {
                            "name": "Sample name",
                            "manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
                            "document_number": "11.222.333/0001-81"
                        }
                    }
                }
            },
            "due_date": "2024-02-17",
            "face_value": 629.33,
            "status": "pending_registration",
            "participant_control_number": "TBFBDWKTEWJ7UTR6CPL4BAE4P",
            "borrower": {
                "document_number": "969.698.790-03",
                "name": "mgkstsdibe",
                "person_type": "natural_person",
                "address": {
                    "postal_code": "05425-020"
                }
            },
            "assignor": {
                "name": "Assignor LTDA",
                "document_number": "33.444.555/0001-81",
                "person_type": "legal_person"
            },
            "bankslip_type": "simple_collection",
            "collection_type": "standard",
            "delay": null,
            "occurrences": [
                {
                    "occurrence_key": "07ad7fce-fec6-40ac-be22-1ffd031f36bc",
                    "status": "pending_submission",
                    "type": "registration",
                    "occurrence_data": null
                }
            ],
            "settlement_instructions": [
                {
                    "settlement_instruction_key": "fe419363-bf04-4b3a-90bd-185618baa720",
                    "status": "pending_bankslip_payment",
                    "asset_type": "duplicata_mercantil",
                    "asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
                    "issue_date": "2025-01-17",
                    "maturity_date": "2026-09-17",
                    "face_value": 629.33,
                    "order_number": "49761-1"
                }
            ]
        }
    ],
    "limit": 15,
    "page": 0,
    "is_last_page": true
}

分页对象​

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

Bankslip​

字段类型描述
bankslip_keystringBoleto 的唯一标识。
external_participant_control_numberstring参与方外部控制编号。
due_datedateBoleto 到期日。
face_valuenumberBoleto 面值。
statusstringBoleto 当前状态。
participant_control_numberstring参与方内部控制编号。
bankslip_configurationobject包含 Boleto 配置的对象（见下文）。
borrowerobject表示借款人（sacado）的对象。
assignorobject表示应收账款转让方的对象。
bankslip_typestringBoleto 类型：simple_collection 或 non_vinculated。
collection_typestring收款方式：standard 或 qr_code_allowed。
delayobjectBoleto 的逾期数据（利息和罚金），已配置时返回。
order_numberstring订单编号。有值时返回。
our_numbernumber我方编号（nosso número）。有值时返回。
our_number_digitstring我方编号的校验位。有值时返回。
digitable_linestring可读编码行（linha digitável）。有值时返回。
barcodestring条形码。有值时返回。
qr_codeobjectBoleto 的二维码数据。有值时返回。
occurrencesarray与 Boleto 相关的事件列表（每项为一个对象）。
settlement_instructionsarray与 Boleto 相关的清算指令列表。

Bankslip Configuration​

字段类型描述
bankslip_configuration_keystringBoleto 配置的 key。
bankslip_profileobject关联的 Boleto 档案。

Bankslip Profile​

字段类型描述
bankslip_profile_keystringBoleto 档案的标识。
bankslip_profile_codestring档案代码。
bankslip_profile_numbernumber档案编号。
bankslip_providerstringBoleto 服务提供方。
additional_informationobject附加信息（见下文）。
internal_account_keystring关联的内部账户标识。
fund_classobject表示投资基金的对象（见下文）。

Fund Class​

字段类型描述字符数
namestring基金类别名称最多 255
fund_class_keystring基金类别的唯一标识 key36
document_numberstring基金类别的 CNPJ-

Borrower​

字段类型描述
namestring借款人名称。
document_numberstring证件号（CPF/CNPJ）。
person_typestring人员类型。
addressobject借款人地址（见下文）。

Address​

字段类型描述
streetstring街道。
numberstring门牌号。
neighborhoodstring街区。
citystring城市。
postal_codestring邮政编码（CEP）。
ufstring联邦单位（州缩写）。
countrystring国家，ISO Alpha-3 格式。

Assignor（转让方）​

字段类型描述
namestring转让方名称。
document_numberstring证件号（CNPJ）。
person_typestring人员类型。

Occurrences​

数组中的每一项都是包含以下字段的对象：

字段类型描述
occurrence_keystring事件的标识。
statusstring事件状态。
typestring事件类型。
occurrence_dataobject事件的附加数据。

Settlement Instructions​

数组中的每一项都是包含以下字段的对象：

字段类型描述
settlement_instruction_keystring清算指令的标识。
statusstring清算指令的状态。
asset_typestring资产类型。
asset_keystring资产在系统中的唯一 key。
issue_datedate签发日期。
maturity_datedate到期日。
face_valuenumber资产面值。
order_numberstring合同编号。
installment_numbernumber资产的分期期数。

错误​

状态码代码触发条件
400BSC000002borrower_document_number 或 assignor_document_number 不是有效的 CPF/CNPJ。
404BSC000006该 fund_class_key 不存在。
403BSC000036该基金不属于您的角色。

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