Skip to main content

Bankslip Retrieval

Bankslip List​

Request​

Available on
ProfileHostRequired permission
Managermanager-apiRead
Consultantconsultant-apiGranted by the integration team

Base URL for each host: Environments (Hosts).

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

Query Params​

ParameterDescription
limitValue between 0 and 100 with the number of items per page. Default: 10.
pagePage number (starting from zero).
borrower_document_numberBorrower document number (numbers only).
assignor_document_numberAssignor document number (numbers only).
participant_control_numberParticipant control number.
order_numberContract number.
our_numberThe bankslip's "nosso número" at the bank.
statusBankslip status: created, pending_registration, registered, waiting_payment_confirmation, paid, paid_via_qr_code, rejected, written_off or registration_failed.
from_due_dateDue date from this date (YYYY-MM-DD).
to_due_dateDue date up to this date (YYYY-MM-DD).
bankslip_typeBankslip type: simple_collection or non_vinculated.
asset_keyKey of the asset linked to the bankslip.

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
}

Paginated Object​

FieldTypeDescription
dataarrayList of Bankslip objects
limitintLimit of objects retrieved per page
pageintRetrieved page number
is_last_pagebooleanInformation indicating if the retrieved page is the last one

Bankslip​

FieldTypeDescription
bankslip_keystringUnique bankslip identifier.
external_participant_control_numberstringExternal participant control number.
due_datedateBankslip due date.
face_valuenumberBankslip face value.
statusstringCurrent bankslip status.
participant_control_numberstringInternal participant control number.
bankslip_configurationobjectObject containing the bankslip configuration (see below).
borrowerobjectObject representing the borrower (payer).
assignorobjectObject representing the receivables assignor.
bankslip_typestringBankslip type: simple_collection or non_vinculated.
collection_typestringCollection type: standard or qr_code_allowed.
delayobjectLate payment data of the bankslip (interest and fine), when set.
order_numberstringOrder number. Present when available.
our_numbernumber"Nosso número". Present when available.
our_number_digitstringCheck digit of the "nosso número". Present when available.
digitable_linestringDigitable line. Present when available.
barcodestringBarcode. Present when available.
qr_codeobjectQR Code data of the bankslip. Present when available.
occurrencesarrayList of bankslip-related occurrences (each item is an object).
settlement_instructionsarrayList of settlement instructions related to the bankslip.

Bankslip Configuration​

FieldTypeDescription
bankslip_configuration_keystringBankslip configuration key.
bankslip_profileobjectAssociated bankslip profile.

Bankslip Profile​

FieldTypeDescription
bankslip_profile_keystringBankslip profile identifier.
bankslip_profile_codestringProfile code.
bankslip_profile_numbernumberProfile number.
bankslip_providerstringBankslip provider.
additional_informationobjectAdditional information (see below).
internal_account_keystringAssociated internal account identifier.
fund_classobjectObject representing the investment fund (see below).

Fund Class​

FieldTypeDescriptionCharacters
namestringFund class nameup to 255
fund_class_keystringFund class unique identification key36
document_numberstringFund class CNPJ-

Borrower​

FieldTypeDescription
namestringBorrower name.
document_numberstringDocument (CPF/CNPJ).
person_typestringPerson type.
addressobjectBorrower address (see below).

Address​

FieldTypeDescription
streetstringAddress street.
numberstringAddress number.
neighborhoodstringNeighborhood.
citystringCity.
postal_codestringPostal code.
ufstringFederative unit (state abbreviation).
countrystringCountry in ISO Alpha-3 format.

Assignor (Cedente)​

FieldTypeDescription
namestringAssignor name.
document_numberstringDocument (CNPJ).
person_typestringPerson type.

Occurrences​

Each array item is an object with the following fields:

FieldTypeDescription
occurrence_keystringOccurrence identifier.
statusstringOccurrence status.
typestringOccurrence type.
occurrence_dataobjectAdditional occurrence data.

Settlement Instructions​

Each array item is an object with the following fields:

FieldTypeDescription
settlement_instruction_keystringSettlement instruction identifier.
statusstringSettlement instruction status.
asset_typestringAsset type.
asset_keystringUnique key of the asset in the system.
issue_datedateIssue date.
maturity_datedateMaturity date.
face_valuenumberFace value of the asset.
order_numberstringContract number.
installment_numbernumberInstallment number of the asset.

Errors​

StatusCodeWhen it happens
400BSC000002borrower_document_number or assignor_document_number is not a valid CPF/CNPJ.
404BSC000006The fund_class_key does not exist.
403BSC000036The fund does not belong to your profile.

Authentication, permission and host errors: see API errors.