Skip to main content

Recuperação de Boletos

Lista de Boletos​

Request​

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

Query Params​

ParâmetroDescrição
limitValor entre 0 e 100 com o número de itens por página.
pageNúmero da pagina (começando por zero).
borrower_document_numberNúmero de documento do tomador (somente números).
assignor_document_numberNúmero de documento do cedente (somente números).
participant_control_numberNúmero de controle do participante.
order_numberNúmero do contrato.
our_numberNosso número do boleto no banco.
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
}

Objeto Paginado​

CampoTipoDescrição
dataarrayLista de objetos de Bankslip
limitintLimite de objetos recuperados por página
pageintNúmero da página recuperada
is_last_pagebooleanInformação que indica se a página recuperada é a última

Bankslip​

CampoTipoDescrição
bankslip_keystringIdentificador único do boleto.
external_participant_control_numberstringNúmero de controle externo do participante.
asset_typestringTipo de ativo atrelado.
due_datedateData de vencimento do boleto.
face_valuenumberValor nominal do boleto.
statusstringStatus atual do boleto.
participant_control_numberstringNúmero de controle interno do participante.
bankslip_configurationobjectObjeto que contém a configuração do boleto (ver abaixo).
borrowerobjectObjeto que representa o tomador (sacado).
assignorobjectObjeto que representa o cedente do recebível.
occurrencesarrayLista de ocorrências relacionadas ao boleto (cada item é um objeto).

Bankslip Configuration​

CampoTipoDescrição
bankslip_configuration_keystringChave de configuração do boleto.
bankslip_profileobjectPerfil de boleto associado.

Bankslip Profile​

CampoTipoDescrição
bankslip_profile_keystringIdentificador do perfil de boleto.
bankslip_profile_codestringCódigo do perfil.
bankslip_profile_numbernumberNúmero do perfil.
bankslip_providerstringProvedor do boleto.
additional_informationobjectInformações adicionais (ver abaixo).
internal_account_keystringIdentificador da conta interna associada.
fund_classobjectObjeto representando o fundo de investimento (ver abaixo).

Fund Class​

CampoTipoDescriçãoCaracteres
namestringNome da classe de fundoaté 255
fund_class_keystringChave única de identificação da classe de fundo36
document_numberstringCNPJ da classe de fundo-

Borrower​

CampoTipoDescrição
namestringNome do tomador.
document_numberstringDocumento (CPF/CNPJ).
person_typestringTipo de pessoa.
addressobjectEndereço do tomador (ver abaixo).

Address​

CampoTipoDescrição
streetstringLogradouro do endereço.
numberstringNúmero do endereço.
neighborhoodstringBairro.
citystringCidade.
postal_codestringCEP.
ufstringUnidade federativa (sigla do estado).
countrystringPaís no formato ISO Alpha-3.

Assignor (Cedente)​

CampoTipoDescrição
namestringNome do cedente.
document_numberstringDocumento (CNPJ).
person_typestringTipo de pessoa.

Occurrences​

Cada item do array é um objeto com os seguintes campos:

CampoTipoDescrição
occurrence_keystringIdentificador da ocorrência.
statusstringStatus da ocorrência.
typestringTipo da ocorrência.
occurrence_dataobjectDados adicionais da ocorrência.