Bankslip Retrieval and Second Copy

Retrieve a bankslip

Request

Available on

Profile	Host	Required permission
Manager	manager-api	Read
Consultant	consultant-api	Granted by the integration team

Base URL for each host: Environments (Hosts).

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslip/BANKSLIP_KEY

METHOD

GET

Response

Response Body

Response Body

{
        
    "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": "2026-04-21",
    "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_url": "https://URL_DO_PDF_DO_BOLETO"

        
}

Bankslip

Field	Type	Description
bankslip_key	string	Unique identifier of the bankslip.
external_participant_control_number	string	External control number of the participant.
due_date	date	Due date of the bankslip.
face_value	number	Nominal value of the bankslip.
status	string	Current status of the bankslip.
participant_control_number	string	Internal control number of the participant.
bankslip_configuration	object	Object containing the bankslip configuration (see below).
borrower	object	Object representing the drawee (borrower).
assignor	object	Object representing the assignor of the receivable.
bankslip_type	string	Bankslip type: simple_collection or non_vinculated.
collection_type	string	Collection type: standard or qr_code_allowed.
delay	object	Late payment data of the bankslip (interest and fine), when set.
order_number	string	Order number. Present when available.
our_number	number	"Nosso número". Present when available.
our_number_digit	string	Check digit of the "nosso número". Present when available.
digitable_line	string	Digitable line. Present when available.
barcode	string	Barcode. Present when available.
qr_code	object	QR Code data of the bankslip. Present when available.
occurrences	array	List of occurrences related to the bankslip (each item is an object).
settlement_instructions	array	List of settlement instructions related to the bankslip.
bankslip_url	string	Link to the bankslip PDF (second copy). Absent while the PDF is not yet available at the bank.

Bankslip Configuration

Field	Type	Description
bankslip_configuration_key	string	Configuration key of the bankslip.
bankslip_profile	object	Associated bankslip profile.

---

Bankslip Profile

Field	Type	Description
bankslip_profile_key	string	Identifier of the bankslip profile.
bankslip_profile_code	string	Code of the profile.
bankslip_profile_number	number	Number of the profile.
bankslip_provider	string	Provider of the bankslip.
additional_information	object	Additional information (see below).
internal_account_key	string	Identifier of the associated internal account.
fund_class	object	Object representing the investment fund (see below).

Fund Class

Field	Type	Description	Characters
name	string	Name of the fund class	up to 255
fund_class_key	string	Unique identification key of the fund class	36
document_number	string	CNPJ of the fund class	-

Borrower

Field	Type	Description
name	string	Name of the drawee.
document_number	string	Document (CPF/CNPJ).
person_type	string	Person type.
address	object	Address of the drawee (see below).

Address

Field	Type	Description
street	string	Street of the address.
number	string	Number of the address.
neighborhood	string	Neighborhood.
city	string	City.
postal_code	string	Postal code.
uf	string	Federative unit (state abbreviation).
country	string	Country in the ISO Alpha-3 format.

---

Assignor (Cedente)

Field	Type	Description
name	string	Name of the assignor.
document_number	string	Document (CNPJ).
person_type	string	Person type.

---

Occurrences

Each item of the array is an object with the following fields:

Field	Type	Description
occurrence_key	string	Identifier of the occurrence.
status	string	Status of the occurrence.
type	string	Type of the occurrence.
occurrence_data	object	Additional data of the occurrence.

Settlement Instructions

Each item of the array is an object with the following fields:

Field	Type	Description
settlement_instruction_key	string	Identifier of the settlement instruction.
status	string	Status of the settlement instruction.
asset_type	string	Asset type.
asset_key	string	Unique key of the asset in the system.
issue_date	date	Issue date.
maturity_date	date	Maturity date.
face_value	number	Face value of the asset.
order_number	string	Contract number.
installment_number	number	Installment number of the asset.

Errors

Status	Code	When it happens
404	BSC000009	There is no bankslip with this bankslip_key in the given profile.
404	BSC000006	The fund_class_key does not exist.
403	BSC000036	The fund does not belong to your profile.

Authentication, permission and host errors: see API errors.