Plataforma de Comunicação Elgin versão 3.13.9
Documentação das bibliotecas de integração com hardware Elgin
Descrição das Chaves

Chaves

INFORMAÇÕES

loja: Conterá o código da loja cadastrado dentro do estabelecimento no ElginTef para a qual as transações serão realizadas. A automação comercial cadastrará esse dado apenas uma vez usando a função ConfigurarDadosPDV

vercaoAc: Contém a versão da automação comercial. A automação comercial cadastrará esse dado apenas uma vez usando a função ConfigurarDadosPDV Enviado obrigatoriamente no serviçoiniciar.

retorno: Contém o código com a solicitação ou resultado do serviço, onde:

Código Situação ElginTef -> Aplicação Comercial Aplicação Comercial -> ElginTef
0 sucesso Com confirmação da Aplicação Comercial Confirmar transação
1 sucesso Sem confirmação da Aplicação Comercial Executar serviço
2 erro Sequencial inválido
3 erro Transação cancelada pelo operador
4 erro Transação cancelada pelo cliente
5 erro Parâmetros insuficientes ou inválidos
6 erro Problemas na conexão do ElginTef
7 erro Problemas entre o ElginTef e a Rede
8 erro Tempo limite de espera excedido Tempo limite de espera excedido
9 erro Problema desconhecido Cancelar transação

As mensagens enviadas do ElginTef para a Aplicação Comercial com sucesso (retorno="0"ou "1") diferem por necessitar uma resposta (se sucesso ou não) por parte da Aplicação Comercial ou não, respectivamente. Normalmente, as transações que necessitam de confirmação, são as que fazem movimentação de dinheiro (ex.: Vendas, Pagamentos, etc.), sendo que asdemais não necessitam.

identificadorPontoCaptura: Enviado pela Aplicação Comercial para o ElginTef em todos os serviços e conterá o código do terminal cadastrado dentro da loja no ElginTef através do qual as transações serão realizadas.

mensagemResultado: Mensagem complementar do serviço executado. Pode estar presente tanto em caso de sucesso quanto em caso de erro. Pode ser enviada pela Aplicação Comercial para o ElginTef e vice-versa. No caso do serviço coletar ela é obrigatória.

sequencial: Deve estar presente em todas as mensagens. É um número sequencial único crescente, enviado pela Aplicação Comercial para o ElginTef a cada novo serviço solicitado, e que deve permanecer o mesmo durante toda a execução daquele serviço. O ElginTef responderá com o mesmo sequencial. Se a Aplicação Comercial enviar um sequencial inválido para iniciar um novo serviço, isto é, menor ou igual ao último utilizado, receberá como resposta o retorno="2" e o próximo sequencial válido. Este procedimento é útil quando a Aplicação Comercial for reiniciada, perdendo o último sequencial utilizado.

textoPinpad: Enviado pela Aplicação Comercial e conterá a informação a ser exibida na telado PIN-Pad. Deve ter no máximo 32 posições.

nomeEstabelecimento: Conterá o código do estabelecimento cadastrado no ElginTef para o qual as transações serão realizadas. A automação comercial cadastrará esse dado apenas uma vez usando a função ConfigurarDadosPDV

TRANSAÇÕES

nsuTerminal: É o Número Sequencial Único (NSU) gerado pelo ElginTef usado para identificar uma transação dentro de uma rede em uma data especifica. Enviado pelo ElginTef para a Aplicação Comercial ao executar uma transação. Pode ser enviado pela Aplicação Comercial para o ElginTef nas transações de cancelamento, reimpressão e tratamento de pendências, evitando assim sua coleta. Para processar a última transação deve-se enviar zero.

valorTotal: Quando informado deve ser maior que zero e contém o valor da transação a ser ou que foi executada. Quando enviado pelo ElginTef, é o valor da transação que foi executada. Quando enviado pela Aplicação Comercial, é o valor a ser apresentado no campo de coleta do valor da transação.

numeroParcelas: Quando informado conterá a quantidade de parcelas. Quando enviado pela Aplicação Comercial conterá a quantidade de parcelas a ser utilizada na execução da transação solicitada. Quando enviado pelo ElginTef conterá a quantidade de parcelas da transação executada.

nsuTransacao: É o Número Sequencial Único (NSU) gerado por algumas Redes usado para identificar uma transação. Enviado pelo ElginTef para a Aplicação Comercial ao executar uma transação quando o mesmo existir, isto é, for gerado pela Rede.

cnpjCredenciadora: Enviado pelo ElginTef para Aplicação Comercial, normalmente em uma transação aprovada, e contém o CNPJ da Rede (chamada também de Credenciadora) responsável pelo roteamento e/ou execução da transação, quando o CNPJ estiver cadastrado no ElginTef. Está implementação é para atender às exigências das Secretarias da Fazenda dos Estados referente ao PAF, ECF, NFC-e, SAT, etc..

formaPagamento: Quando informado deve ser "A vista", "Parcelado" ou "Pre-datado". Quando enviado pela Aplicação Comercial conterá a forma de pagamento a ser utilizado na transação solicitada. Quando enviado pelo ElginTef conterá a forma de pagamento utilizado na transação executada.

tipoFinanciamento: Aplica-se somente para pagamento="Parcelado". Quando especificado deve ser "Estabelecimento" ou "Administradora". Quando enviado pela Aplicação Comercial conterá quem deve ser o financiador utilizado na transação solicitada. Quando enviado pelo ElginTef conterá o financiador utilizado na transação executada.

tipoCartao: Quando informado deve ser "Debito" ou "Credito". Quando enviado pela Aplicação Comercial conterá os tipos de cartão que podem ser utilizados na execução da transação solicitada. Quando enviado pelo ElginTef conterá o tipo de cartão utilizado na transação executada.

codigoAutorizacao: Quando existir conterá o código de autorização da transação que foi executada, normalmente gerado pela administradora.

panMascarado: Enviado pela Aplicação Comercial para o ElginTef. Contém o número impresso no cartão e é utilizado normalmente em transações digitadas.

nomeBandeira: É a administradora responsável pela autorização da transação (ex.: Banricompras, Mastercard, Santander, Visa, etc.), também conhecida como bandeira. Quando enviada pela Aplicação Comercial conterá as administradoras que podem ser utilizadas na transação solicitada. Quando enviado pelo ElginTef conterá a administradora que foi utilizada na execução da transação.

comprovanteDiferenciadoPortador: Quando especificado conterá(ão) o(s) comprovantes gerados pela execução da transação, enviados pelo ElginTef para a Aplicação Comercial. A sequência de caracteres Carriage-Return/Line-Feed (CR/LFou0x0D/0x0A) serão utilizados para separar as linhas.

comprovanteDiferenciadoLoja: Quando especificado conterá(ão) o(s) comprovantes gerados pela execução da transação, enviados pelo ElginTef para a Aplicação Comercial. A sequência de caracteres Carriage-Return/Line-Feed (CR/LFou0x0D/0x0A) serão utilizados para separar as linhas.

admSenha: É a senha do usuário enviado pela Aplicação Comercial para o ElginTef para autenticação nas transações administrativas.

admUsuario: É o código do usuário enviado pela Aplicação Comercial para o ElginTef para autenticação nas transações administrativas.

COLETA

automacao_coleta_tipo: Enviado pelo ElginTef para Aplicação Comercial sempre quando for coletar alguma informação, e conterá o tipo de informação a ser coletada, onde:

Quando informado e automacao_coleta_mascara não informado, as máscaras padrões serão:

automacao_coleta_opcao: Enviado pelo ElginTef para Aplicação Comercial. Quando informado conterá a lista com as opções permitidas para seleção. Uma delas deverá ser selecionada. Os valores serão separados por ponto e virgula. Seguem alguns exemplos:

automacao_coleta_timeout: Pode ser enviado do ElginTef para Aplicação Comercial e vice-versa. Quando informado conterá o tempo máximo em segundos que o enviador aguardará a resposta do recebedor. Quando o tempo for ultrapassado a transação será abortada com retorno=”8”.

automacao_coleta_retorno: Código utilizado na interação entre o ElginTef e a Aplicação Comercial. Estará presente em todas as mensagens, e será utilizado para conduzir todo o processo. Após o ElginTef receber a solicitação de execução de uma transação da Aplicação Comercial, e este estiver configurado para coletar as informações através da Aplicação Comercial, o ElginTef coletará as informações enviando ‘automacao_coleta_retorno='0’e recebendo a resposta comautomacao_coleta_retorno='0'` com os dados solicitados até a coleta de todas as informações necessárias para execução da transação.

mensagemResultado: Enviado pelo ElginTef para Aplicação Comercial e vice-versa. Quando enviado pelo ElginTef para a Aplicação Comercial e coletando alguma informação conterá o título do campo a ser coletado, e se não coletando conterá uma mensagem a ser exibida pela Aplicação Comercial para o operador. Pode ser enviado pela Aplicação Comercial para ElginTef, por exemplo quando uma transação for abortada e a Aplicação Comercial quer informar o motivo. Esta mensagem poderá conter mais de uma linha, quando existirão a sequênciade caracteres Carriage-Return/Line-Feed (CR/LFou0x0D/0x0A) para separá-las, e neste caso deve ser exibida semelhante a um comprovante, de forma que o operador possa visualizar todo seu conteúdo.

automacao_coleta_informacao: Enviado pela Aplicação Comercial para o ElginTef. Contém a informação coletada pela Aplicação Comercial.

automacao_coleta_sequencial: Número sequencial único enviado em todas as mensagens, para garantir a consistencia na troca de informações entre o ElginTef e a Aplicação Comercial. Ao iniciar uma nova coleta de informações o ElginTef iniciará este valor em 1 (um), incrementando de 1 em 1 a cada nova mensagem, e a Aplicação Comercial deve devolver na mensagem de resposta o mesmo valor recebido.

automacao_coleta_palavra_chave: Enviada pelo ElginTef para Aplicação Comercial quando solicitado a coleta de alguma informação, e conterá a palavra-chave referente à informação que está sendo coletada. Exemplos: automacao_coleta_palavra_chave="transacao_valor" indica a coleta do valor da transação;automacao_coleta_palavra_chave="transacao_cartao_numero" indica a coleta do número do cartão.