跳到主要内容

获取银行划账单

银行划账单列表​

Request​

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

Query Params​

参数描述
limit0 到 100 之间的值，表示每页项目数量。
page页码（从零开始）。
borrower_document_number借款人文件编号（仅数字）。
assignor_document_number转让方文件编号（仅数字）。
participant_control_number参与者控制编号。
order_number合同编号。
our_number银行中的银行划账单编号。

Response​

Response Body
Response Body
{
    "data": [
        {
            "bankslip_key": "c9eb109c-800f-4cf5-b209-2119c9d77a72",
            "external_participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
            "asset_type": "duplicata_mercantil",
            "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": "51.620.927/0001-65",
                        "name": "Sample_Name",
                        "manager": {
                            "name": "Sample name",
                            "manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
                            "document_number": "51.620.927/0001-65"
                        }
                    }
                }
            },
            "due_date": "2024-02-17",
            "face_value": 629.33,
            "status": "pending_registration",
            "participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
            "borrower": {
                "document_number": "755.510.684-12",
                "name": "Tomador",
                "person_type": "legal_person",
                "address": {
                    "postal_code": "05425-020"
                }
            },
            "assignor": {
                "name": "Assignor LTDA",
                "document_number": "37.341.966/0001-00",
                "person_type": "legal_person"
            },
            "occurrences": [
                {
                    "occurrence_key": "e9898e50-cd2b-492f-9201-7e5c5f231853",
                    "status": "pending_submission",
                    "type": "registration",
                    "occurrence_data": null
                }
            ]
        },
        {
            "bankslip_key": "4584e60c-752f-479d-831a-50f09c2c7de2",
            "external_participant_control_number": "TBFBDWKTEWJ7UTR6CPL4BAE4P",
            "asset_type": "duplicata_mercantil",
            "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": "51.620.927/0001-65",
                        "name": "Sample_Name",
                        "manager": {
                            "name": "Sample name",
                            "manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
                            "document_number": "51.620.927/0001-65"
                        }
                    }
                }
            },
            "due_date": "2024-02-17",
            "face_value": 629.33,
            "status": "pending_registration",
            "participant_control_number": "TBFBDWKTEWJ7UTR6CPL4BAE4P",
            "borrower": {
                "document_number": "784.508.035-78",
                "name": "mgkstsdibe",
                "person_type": "legal_person",
                "address": {
                    "postal_code": "05425-020"
                }
            },
            "assignor": {
                "name": "Assignor LTDA",
                "document_number": "37.341.966/0001-00",
                "person_type": "legal_person"
            },
            "occurrences": [
                {
                    "occurrence_key": "07ad7fce-fec6-40ac-be22-1ffd031f36bc",
                    "status": "pending_submission",
                    "type": "registration",
                    "occurrence_data": null
                }
            ]
        }
    ],
    "limit": 15,
    "page": 0,
    "is_last_page": true
}

分页对象​

字段类型描述
dataarrayBankslip 对象列表
limitint每页返回的对象数量上限
pageint当前返回的页码
is_last_pageboolean表示当前页是否为最后一页

Bankslip​

字段类型描述
bankslip_keystring银行划账单的唯一标识。
external_participant_control_numberstring参与者外部控制编号。
asset_typestring关联的资产类型。
due_datedate银行划账单到期日。
face_valuenumber银行划账单名义金额。
statusstring银行划账单当前状态。
participant_control_numberstring参与者内部控制编号。
bankslip_configurationobject包含银行划账单配置的对象（见下文）。
borrowerobject表示借款人（付款人）的对象。
assignorobject表示应收账款转让方的对象。
occurrencesarray与银行划账单相关的事件列表（每个项目为一个对象）。

Bankslip Configuration​

字段类型描述
bankslip_configuration_keystring银行划账单配置键。
bankslip_profileobject关联的银行划账单配置文件。

Bankslip Profile​

字段类型描述
bankslip_profile_keystring银行划账单配置文件标识。
bankslip_profile_codestring配置文件代码。
bankslip_profile_numbernumber配置文件编号。
bankslip_providerstring银行划账单提供商。
additional_informationobject附加信息（见下文）。
internal_account_keystring关联内部账户标识。
fund_classobject表示投资基金的对象（见下文）。

Fund Class​

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

Borrower​

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

Address​

字段类型描述
streetstring街道地址。
numberstring门牌号。
neighborhoodstring社区/街区。
citystring城市。
postal_codestring邮政编码。
ufstring联邦单位（州缩写）。
countrystringISO Alpha-3 格式的国家代码。

Assignor（转让方）​

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

Occurrences​

数组中每个项目是具有以下字段的对象：

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

特定银行划账单​

Request​

ENDPOINT
/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_configuration/BANKSLIP_CONFIGURATION_KEY/bankslip/BANKSLIP_KEY
MÉTODO
GET

Response​

Response Body
Response Body
{
    "bankslip_key": "283bd9f4-7a18-4947-870e-cdb7170be6cb",
    "external_participant_control_number": "0175458470012171954123456",
    "bankslip_configuration": {
        "bankslip_configuration_key": "b3d4a489-a9d1-4afd-b1fc-719a06a1b49a",
        "bankslip_profile": {
            "bankslip_profile_key": "77dac6b1-2744-42d7-a9a1-57384e078e75",
            "bankslip_profile_code": "329-09-0001-1234567",
            "bankslip_profile_number": 9,
            "bankslip_provider": "qi_scd",
            "additional_information": {
                "requester_profile_key": "7c39615a-ae39-44be-b3b3-44b25ade2583"
            },
            "internal_account_key": "545fb51c-1e8e-4019-92dc-cae42eb5e1df",
            "fund_class": {
                "fund_class_key": "48ea2b09-d975-48d5-90e9-180af52441d1",
                "document_number": "21.453.503/0001-00",
                "name": "FUNDO FIDC",
                "manager": {
                    "name": "GESTORA",
                    "manager_key": "d59acd84-e81c-4822-9f34-968a8ccf54bd",
                    "document_number": "12.345.678/0001-01"
                }
            }
        }
    },
    "due_date": "2030-03-03",
    "face_value": 3000.0,
    "status": "registered",
    "participant_control_number": "0175324300089281954563002",
    "borrower": {
        "name": "BORROWER",
        "document_number": "00.000.000/0001-00",
        "person_type": "legal_person",
        "address": {
            "street": "RUA DOS PINHEIROS",
            "number": "250",
            "neighborhood": "SPINHEIROS",
            "city": "SAO PAULO",
            "postal_code": "74015-170"
        }
    },
    "assignor": {
        "name": "CEDENTE LTDA",
        "document_number": "01.001.001/0001-01",
        "person_type": "legal_person"
    },
    "bankslip_type": "simple_collection",
    "order_number": "31234-1",
    "digitable_line": "32990001039000000000101634386701233740000700000",
    "barcode": "39483137400003000000001090000000000161938270",
    "occurrences": [
        {
            "occurrence_key": "187b8700-361d-4df4-ba71-930f79a835a4",
            "status": "succeeded",
            "type": "registration",
            "occurrence_data": null
        }
    ],
    "settlement_instructions": [
        {
            "settlement_instruction_key": "eefbe1c4-bd85-4ba0-9400-4a0e20889dc7",
            "status": "pending_bankslip_payment",
            "issue_date": "2025-02-05",
            "maturity_date": "2030-03-03",
            "face_value": 3000.0,
            "asset_type": "duplicata_servicos",
            "asset_key": "c9168305-334e-47a1-91d6-6448337b5fd1",
            "order_number": "31234-1"
        }
    ],
    "bankslip_url": "https://url.com/c9168305-334e-47a1-91d6-6448337b5fd1_1.pdf"
}