Listar solicitações de criação de CNAB 444

Esse endpoint permite a consulta paginada das solicitações de criação de arquivos CNABs.

Parâmetros da URL para paginação:

• page (integer, opcional): O nº da página para paginação.
  
• size (integer, opcional): A quantidade de itens a serem retornados na paginação.
  

Parâmetros de requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

• content (object): Objeto contendo o resultado com as solicitações realizadas.
  
• total_pages (int): Quantidade de páginas para paginação.
  
• total_elements (int): Quantidade total de registros encontrados.
  
• has_next (boolean): Flag para indicar se terá a próxima página para paginação.
  

Objeto "content"

• id (uuid v4): ID da solicitação para o arquivo.
  
• status (string): Status do processamento do arquivo solicitado.
  
• filters (object): Filtros que foram aplicados na requisição.
  
• parameters (object): Objeto contendo detalhes referentes aos parâmetros de emissão.
  
• error_message (string): Mensagem de erro da solicitação, se aplicável.
  
• created_at (string): Data da criação da solicitação.
  
• updated_at (string): Data da última atualização.
  
• version (string): Versionamento da solicitação.
  

Objeto "parameters"

• cession_date (datetime): Data de cessão da operação.
  
• originator.id (string): O ID para identificação do originador.
  
• originator.external_id (string): O ID externo para o originador.
  
• collection_agency_bank (string): Agência bancária de cobrança.
  
• depository_agency (string): Agência bancária depositária.
  
• cession_term_number (string): Número do termo de cessão.
  

Objeto "filters"

• status (string): Status da operação para geração do CNAB.
  
• created_from (datetime): Data de inicio de criação.
  
• created_to (datetime): Data de fim para criação.
  
• disbursement_date_from (datetime): Data inicio do desembolso.
  
• disbursement_date_to (datetime): Data fim do desembolso.
  
• application_ids (array): Lista contendo as "aplicações" a serem filtradas.
  
• excluded_application_ids (array): Lista contendo as "aplicações" a serem excluídas do filtro.
  

Exemplo de JSON

{
    "content": [
        {
            "id": "",
            "status": "PENDING",
            "filters": {
                "status": "KYC_PROCESSING",
                "created_from": "",
                "created_to": "",
                "disbursement_date_from": "",
                "disbursement_date_to": "",
                "application_ids": [
                    "",
                    ""
                ],
                "excluded_application_ids": [
                    "",
                    ""
                ]
            },
            "parameters": {
                "cession_date": "",
                "originator": {
                    "id": "",
                    "external_id": ""
                },
                "collection_agency_bank": "",
                "depository_agency": "",
                "cession_term_number": ""
            },
            "error_message": "",
            "created_at": "",
            "updated_at": "",
            "version": ""
        },
        {
            "id": "",
            "status": "SUCCESS",
            "filters": {
                "status": "DISBURSEMENT_ATTEMPT_FAILED",
                "created_from": "",
                "created_to": "",
                "disbursement_date_from": "",
                "disbursement_date_to": "",
                "application_ids": [
                    "",
                    ""
                ],
                "excluded_application_ids": [
                    "",
                    ""
                ]
            },
            "parameters": {
                "cession_date": "",
                "originator": {
                    "id": "",
                    "external_id": ""
                },
                "collection_agency_bank": "",
                "depository_agency": "",
                "cession_term_number": ""
            },
            "error_message": "",
            "created_at": "",
            "updated_at": "",
            "version": ""
        }
    ],
    "total_pages": "",
    "total_elements": "",
    "has_next": ""
}