Informações e diagnóstico da biblioteca

Operação responsável por obter informações operacionais e de configuração da biblioteca Client Conecta instalada no estabelecimento.

Por meio dessa operação, é possível consultar dados como:

  • Versão da biblioteca em execução;
  • Identificador do terminal (TerminalId) configurado;
  • Ambiente ativo, homologação ou produção;
  • Porta de comunicação utilizada pelo Pin Pad;
  • Estado atual de inicialização do client;
  • Informações relevantes para diagnóstico e validação do ambiente;
  • Informações detalhadas do pinpad conectado, incluindo dados de hardware, firmware, versões de kernels EMV e contactless, fabricante, modelo, capabilities e características técnicas do dispositivo.
📘

O retorno da operação passa a incluir o objeto Pinpad, que reúne informações específicas do dispositivo conectado, como número de série, modelo, fabricante, versões de firmware e bibliotecas, além de características físicas, suporte a mídias e resolução de display. Com isso, é possível obter uma visão mais completa do ambiente de captura.

Em resumo, esta operação permite consultar o estado atual de configuração e execução da biblioteca, incluindo versão, terminal configurado, ambiente ativo e parâmetros de comunicação.

Parâmetros de Entrada

CampoTipoFormatoObrigatórioDescrição
OperstringN..3MCódigo da operação: fixo "4" (CFL_OPER_STATUS)

Mensagem de notificação recebida na callback da operação

Não há.

Dados de resposta recebido na callback da operação

Os dados de resposta são retornados por meio da função de callback no formato JSON, conforme estrutura abaixo.

Campos retornados

CampoTipoFormatoObrigatórioDescrição
OperstringN..3MECódigo da operação: fixo "4" (CFL_OPER_STATUS)
CodestringN..2M

Código de identificação do conteúdo do JSON enviado na função de callback:

“0” = indica que o JSON contém os dados de resposta da operação realizada.

TerminalIdstringA8MNúmero do terminal cadastrado
ConfirmationStatusSetupstringN1M

Configuração da confirmação de transação:

"0" confirmação não automática. A confirmação de uma transação deve ser realizada pela Automação Comercial através da
operação de confirmação definida na Gestão de transação pendente;

“1” = confirmação automática. A confirmação de uma transação é realizada pela biblioteca Client Conecta (default), não sendo necessária nenhuma ação da Automação Comercial.

PortPinpadstringN..2M

Porta de comunicação do Pin Pad “0” à “99”:

"0" = utiliza a primeira porta disponível onde é identificada a presença de um Pin Pad;

"NN" = utiliza o Pin Pad conectado na porta NN.

EnvironmentstringN1M

Identificador do ambiente Cielo Conecta para a realização das transações, sendo:

“0” = “Produção”;

“1” = “Homologação”.

StatusstringN2M

Status da biblioteca Client Conecta:

“00” = não inicializada;

“01” = inicializada, mas não operacional;

“02” = inicializada e operacional.

VersionstringA..99MVersão da Biblioteca Client Conecta.

Pin Pad

CampoTipoFormatoPresençaDescrição
SerialNumberstringA..99MNúmero de série do Pin Pad.
PhysicalCharacteristicsstringA..99MCaracterísticas físicas do dispositivo (ex.: com chip, sem SAM, contactless).
ReturnDataInfostringA..99MCódigo de retorno interno relacionado às informações do Pin Pad.
EmvKernelVersionstringA..99MVersão do kernel EMV instalado no Pin Pad.
ContactlessModuleVersionstringA..99MVersão do módulo de comunicação contactless.
PayPassKernelVersionstringA..99MVersão do kernel PayPass (Mastercard), podendo incluir data de release.
PayWaveKernelVersionstringA..99MVersão do kernel PayWave (Visa), podendo incluir data de release.
HardwareModelstringA..99MModelo do hardware do Pin Pad e capacidade de memória.
ManufacturerstringA..99MFabricante do dispositivo.
FirmwareVersionstringA..99MVersão do firmware instalado no Pin Pad.
BasicLibVersionstringA..99MVersão da biblioteca básica embarcada no Pin Pad.
SpecificationVersionstringA..99MVersão da especificação técnica suportada pelo Pin Pad.
AcquirerVersionstringA..99MVersão dos parâmetros/configurações da adquirente.
TablesVersionstringA..99MVersão das tabelas operacionais carregadas no Pin Pad.
LicenseExpirationDatestringA..99OData de expiração da licença, quando aplicável. Pode vir vazio.
SupportedMediaTypesstringA..99MLista de tipos de mídia suportados (formatos de imagem). Exemplo: [PNG, JPG].
DisplayResolutionstringA..99MResolução da tela do dispositivo em pixels. Exemplo: 240x320 (Largura x Altura).

Retornos

CódigoDescrição
CFL_OKOperação realizada com sucesso.

Did this page help you?