Consultar uma solicitação de criação CNAB 444

Esse endpoint permite a consulta de uma determinada solicitação de criação de um arquivo CNAB.

Parâmetros da URL para paginação:

• id_req_cnab (string): ID da requisição do arquivo.

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:

• 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

{
    "id": "<uuid>",
    "status": "PENDING",
    "filters": {
        "status": "KYC_PROCESSING",
        "created_from": "<dateTime>",
        "created_to": "<dateTime>",
        "disbursement_date_from": "<date>",
        "disbursement_date_to": "<date>",
        "application_ids": [
            "<uuid>",
            "<uuid>"
        ],
        "excluded_application_ids": [
            "<uuid>",
            "<uuid>"
        ]
    },
    "parameters": {
        "cession_date": "<date>",
        "originator": {
            "id": "<uuid>",
            "external_id": "<string>"
        },
        "collection_agency_bank": "<string>",
        "depository_agency": "<string>",
        "cession_term_number": "<string>"
    },
    "error_message": "<string>",
    "created_at": "<dateTime>",
    "updated_at": "<dateTime>",
    "version": "<integer>"
}