Recuperação de Boleto e Segunda via
Consultar boleto
Request
Disponível em
| Perfil | Host | Permissão exigida |
|---|---|---|
| Gestora | manager-api | Leitura |
| Consultoria | consultant-api | Liberada pelo time de integração |
URL base de cada host: Ambientes (Hosts).
ENDPOINT
/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslip/BANKSLIP_KEYMÉTODO
GETResponse
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
| Campo | Tipo | Descrição |
|---|---|---|
bankslip_key | string | Identificador único do boleto. |
external_participant_control_number | string | Número de controle externo do participante. |
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. |
bankslip_type | string | Tipo do boleto: simple_collection ou non_vinculated. |
collection_type | string | Modalidade de cobrança: standard ou qr_code_allowed. |
delay | object | Dados de mora do boleto (juros e multa), quando configurados. |
order_number | string | Número do pedido. Presente quando houver. |
our_number | number | Nosso número. Presente quando houver. |
our_number_digit | string | Dígito verificador do nosso número. Presente quando houver. |
digitable_line | string | Linha digitável. Presente quando houver. |
barcode | string | Código de barras. Presente quando houver. |
qr_code | object | Dados do QR Code do boleto. Presente quando houver. |
occurrences | array | Lista de ocorrências relacionadas ao boleto (cada item é um objeto). |
settlement_instructions | array | Lista de instruções de liquidação relacionadas ao boleto. |
bankslip_url | string | Link do PDF do boleto (segunda via). Ausente quando o PDF ainda não está disponível no banco. |
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. |
Settlement Instructions
Cada item do array é um objeto com os seguintes campos:
| Campo | Tipo | Descrição |
|---|---|---|
settlement_instruction_key | string | Identificador da instrução de liquidação. |
status | string | Status da instrução de liquidação. |
asset_type | string | Tipo do ativo. |
asset_key | string | Chave única do ativo no sistema. |
issue_date | date | Data de emissão. |
maturity_date | date | Data de vencimento. |
face_value | number | Valor de face do ativo. |
order_number | string | Número do contrato. |
installment_number | number | Número da parcela do ativo. |
Erros
| Status | Código | Quando acontece |
|---|---|---|
| 404 | BSC000009 | Não existe boleto com este bankslip_key na carteira informada. |
| 404 | BSC000006 | A fund_class_key não existe. |
| 403 | BSC000036 | O fundo não pertence ao seu perfil. |
Erros de autenticação, permissão e host: veja Erros da API.