Recuperação de Arquivos CNAB

Listar arquivos CNAB

Retorna uma lista paginada de arquivos CNAB (arquivos de remessa e retorno trocados com o banco) pertencentes a um perfil de boleto de uma classe de fundo.

Request

ENDPOINT

/bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/cnab_files

MÉTODO

GET

Path Params

Parâmetro	Descrição
`fund_class_key`	Chave da classe de fundo. Retorna `404` (`NotFoundFundClass`) caso não exista.
`bankslip_profile_key`	Chave do perfil de boleto, que deve pertencer à classe de fundo. Retorna `404` (`NotFoundBankslipConfiguration`) caso não seja encontrado.

Query Params

Todos os parâmetros são opcionais.

Parâmetro	Tipo	Descrição
`initial_date`	date	Filtra arquivos com `cnab_date` maior ou igual à data informada (YYYY-MM-DD).
`final_date`	date	Filtra arquivos com `cnab_date` menor ou igual à data informada (YYYY-MM-DD).
`cnab_type`	string	Filtra pelo tipo do arquivo (ver Tipo de CNAB).
`limit`	int	Valor entre 0 e 20 com o número de itens por página. Padrão: `10`.
`page`	int	Número da página (começando por zero). Padrão: `0`.

Quando is_last_page for false, solicite a próxima page para recuperar os demais resultados.

Response

Response Body

Response Body
{
    "data": [
        {
            "cnab_file_key": "79f21d3e-ed99-413c-8e05-39cf84fbab7c",
            "bankslip_profile": {
                "bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
                "bankslip_profile_code": "329-09-0001-0000000",
                "bankslip_profile_number": 9,
                "bankslip_provider": "qi_scd",
                "additional_information": {
                    "requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
                },
                "internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
                "fund_class": {
                    "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                    "document_number": "00.000.000/0001-01",
                    "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                    "manager": {
                        "name": "GESTÃO DE RECURSOS",
                        "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                        "document_number": "00.100.100/0001-00"
                    }
                }
            },
            "cnab_date": "2025-07-30",
            "type": "return",
            "status": "completed",
            "download_filename": "cnab-retorno-2025-07-30-79f21d3e.ret",
            "url": "https://s3.amazonaws.com/...",
            "external_cnab_file_key": "e8b5e962-eb5f-4b9d-8d2b-70cd6d3d5252",
            "number_of_occurrences": 6
        },
        {
            "cnab_file_key": "ff7aaa47-a901-4f66-98d7-46f76ca4fa16",
            "bankslip_profile": {
                "bankslip_profile_key": "e0771a02-4f3e-4162-a468-a872fc6975e4",
                "bankslip_profile_code": "329-09-0001-0000000",
                "bankslip_profile_number": 9,
                "bankslip_provider": "qi_scd",
                "additional_information": {
                    "requester_profile_key": "cdec985f-e629-44ce-8511-a323f38bd63e"
                },
                "internal_account_key": "5e621ba2-b4ac-4ddd-9893-82d220e1577e",
                "fund_class": {
                    "fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
                    "document_number": "00.000.000/0001-01",
                    "name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
                    "manager": {
                        "name": "GESTÃO DE RECURSOS",
                        "manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
                        "document_number": "00.100.100/0001-00"
                    }
                }
            },
            "cnab_date": "2025-07-30",
            "type": "external_return",
            "status": "completed",
            "download_filename": "cnab-retorno-2025-07-30-ff7aaa47.ret",
            "url": "https://s3.amazonaws.com/...",
            "external_cnab_file_key": "d3b1f7c4-9e2a-4f6b-8c1d-5a7e9b3f2c8e",
            "number_of_occurrences": 3,
            "bankslip_expenses": [
                {
                    "bankslip_expense_key": "4d727b05-00df-454e-93e3-160ec9ee596c",
                    "type": "fee_or_costs.payment",
                    "number_of_expenses": 3,
                    "total_value": 2.25,
                    "status": "completed"
                }
            ]
        }
    ],
    "limit": 10,
    "page": 0,
    "is_last_page": true
}

Objeto Paginado

Campo	Tipo	Descrição
`data`	array	Lista de objetos de CNAB File
`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

CNAB File

Campo	Tipo	Descrição
`cnab_file_key`	string	Identificador único do arquivo CNAB.
`bankslip_profile`	object	Perfil de boleto associado (ver Bankslip Profile).
`cnab_date`	date	Data do arquivo CNAB.
`type`	string	Tipo do arquivo (ver Tipo de CNAB).
`status`	string	Status do arquivo (ver Status do CNAB).
`download_filename`	string	Nome com o qual o arquivo é baixado.
`url`	string	URL pré-assinada para download do arquivo, válida por 1 hora. Omitida caso não seja possível gerá-la.
`external_cnab_file_key`	string	Identificador do arquivo CNAB externo. Presente apenas quando o arquivo possui esse valor.
`header`	string	Header do arquivo. Presente apenas quando o arquivo possui esse valor.
`trailer`	string	Trailer do arquivo. Presente apenas quando o arquivo possui esse valor.
`number_of_occurrences`	int	Número de ocorrências do arquivo. Presente apenas quando o arquivo possui esse valor.
`expectation`	object	Dados de expectativa do arquivo. Presente apenas quando o arquivo possui esse valor.
`bankslip_expenses`	array	Lista de objetos de Bankslip Expense. Presente apenas quando o arquivo possui despesas associadas.

Bankslip Expense

Campo	Tipo	Descrição
`bankslip_expense_key`	string	Identificador único da despesa.
`type`	string	Tipo da despesa.
`number_of_expenses`	int	Quantidade de despesas agrupadas.
`total_value`	number	Valor total das despesas.
`status`	string	Status da despesa.

Tipo de CNAB

Enumerador	Descrição
`return`	Arquivo Retorno
`external_return`	Arquivo Retorno Externo
`remittance`	Remessa
`external_remittance`	Remessa Externa

Status do CNAB

Enumerador	Descrição
`created`	Criado
`pending_processing`	Processamento pendente
`completed`	Concluído
`canceled`	Cancelado

Listar arquivos CNAB​

Request​

Path Params​

Query Params​

Response​

Objeto Paginado​

CNAB File​

Bankslip Expense​

Tipo de CNAB​

Status do CNAB​