Esse endpoint permite a geração de um arquivo CNAB no formato 444 para importação em sistemas externos.
Parâmetros de requisição
-
parameters(object): Objeto contendo detalhes referentes aos parâmetros de emissão. -
cession_date(datetime): Data de cessão da operação. -
originator.id(string, optional): 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. -
filters(object): Objeto contendo os campos para filtro na geração do CNAB.
Objeto "filters"
-
filters.status(string): Status da operação para geração do CNAB. -
filters.created_from(datetime): Data de inicio de criação. -
filters.created_to(datetime): Data de fim para criação. -
filters.disbursement_date_from(datetime): Data inicio do desembolso. -
filters.disbursement_date_to(datetime): Data fim do desembolso. -
filters.application_ids(array): Lista contendo as "aplicações" a serem filtradas. -
filters.excluded_application_ids(array): Lista contendo as "aplicações" a serem excluídas do filtro.
Resposta
Em caso de sucesso será retornado um status 200 e um arquivo JSON confirmando os campos enviados e processados na requisição.
-
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): Parâmetros enviados na requisiçã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.