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âmetro	Descrição
`limit`	Valor entre 0 e 100 com o número de itens por página.
`page`	Número da pagina (começando por zero).
`borrower_document_number`	Número de documento do tomador (somente números).
`assignor_document_number`	Número de documento do cedente (somente números).
`participant_control_number`	Número de controle do participante.
`order_number`	Número do contrato.
`our_number`	Nosso número do boleto no banco.

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
}

Objeto Paginado

Campo	Tipo	Descrição
`data`	array	Lista de objetos de Bankslip
`limit`	int	Limite de objetos recuperados por página
`page`	int	Número da página recuperada
`is_last_page`	boolean	Informação que indica se a página recuperada é a última

Bankslip

Campo	Tipo	Descrição
`bankslip_key`	string	Identificador único do boleto.
`external_participant_control_number`	string	Número de controle externo do participante.
`asset_type`	string	Tipo de ativo atrelado.
`due_date`	date	Data de vencimento do boleto.
`face_value`	number	Valor nominal do boleto.
`status`	string	Status atual do boleto.
`participant_control_number`	string	Número de controle interno do participante.
`bankslip_configuration`	object	Objeto que contém a configuração do boleto (ver abaixo).
`borrower`	object	Objeto que representa o tomador (sacado).
`assignor`	object	Objeto que representa o cedente do recebível.
`occurrences`	array	Lista de ocorrências relacionadas ao boleto (cada item é um objeto).

Bankslip Configuration

Campo	Tipo	Descrição
`bankslip_configuration_key`	string	Chave de configuração do boleto.
`bankslip_profile`	object	Perfil de boleto associado.

Bankslip Profile

Campo	Tipo	Descrição
`bankslip_profile_key`	string	Identificador do perfil de boleto.
`bankslip_profile_code`	string	Código do perfil.
`bankslip_profile_number`	number	Número do perfil.
`bankslip_provider`	string	Provedor do boleto.
`additional_information`	object	Informações adicionais (ver abaixo).
`internal_account_key`	string	Identificador da conta interna associada.
`fund_class`	object	Objeto representando o fundo de investimento (ver abaixo).

Fund Class

Campo	Tipo	Descrição	Caracteres
`name`	string	Nome da classe de fundo	até 255
`fund_class_key`	string	Chave única de identificação da classe de fundo	36
`document_number`	string	CNPJ da classe de fundo	-

Borrower

Campo	Tipo	Descrição
`name`	string	Nome do tomador.
`document_number`	string	Documento (CPF/CNPJ).
`person_type`	string	Tipo de pessoa.
`address`	object	Endereço do tomador (ver abaixo).

Address

Campo	Tipo	Descrição
`street`	string	Logradouro do endereço.
`number`	string	Número do endereço.
`neighborhood`	string	Bairro.
`city`	string	Cidade.
`postal_code`	string	CEP.
`uf`	string	Unidade federativa (sigla do estado).
`country`	string	País no formato ISO Alpha-3.

Assignor (Cedente)

Campo	Tipo	Descrição
`name`	string	Nome do cedente.
`document_number`	string	Documento (CNPJ).
`person_type`	string	Tipo de pessoa.

Occurrences

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

Campo	Tipo	Descrição
`occurrence_key`	string	Identificador da ocorrência.
`status`	string	Status da ocorrência.
`type`	string	Tipo da ocorrência.
`occurrence_data`	object	Dados adicionais da ocorrência.

Boleto específico

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"
}

Lista de Boletos​

Request​

Query Params​

Response​

Objeto Paginado​

Bankslip​

Bankslip Configuration​

Bankslip Profile​

Fund Class​

Borrower​

Address​

Assignor (Cedente)​

Occurrences​

Boleto específico​

Request​

Response​

Lista de Boletos

Request

Query Params

Response

Objeto Paginado

Bankslip

Bankslip Configuration

Bankslip Profile

Fund Class

Borrower

Address

Assignor (Cedente)

Occurrences

Boleto específico

Request

Response