Parâmetros de Entrada
Antes de apresentar as formas de integração, descreveremos neste capítulo as características gerais do m-SiTef.
Ele disponibiliza para o integrador as mesmas funcionalidades da CliSiTef que estão descritas no documento "SiTef - Interface Simplificada com a aplicação" na Tabela de códigos de funções.
Para executar as funções, é obrigatório enviar 4 parâmetros ao m-SiTef: empresaSitef, enderecoSitef, modalidade e CNPJ_CPF. Para a modalidade 0, também é obrigatório o parâmetro valor.
Importante: Todos esses parâmetros apresentados neste documento em trechos de códigos são apenas ilustrativos e devem ser substituídos por valores válidos.
A seguir, estão listados todos os parâmetros aceitos na aplicação.
Tabela 1 - parâmetros de entrada do m-SiTef#
| Parâmetro | Tipo | Descrição |
|---|---|---|
| empresaSitef | Obrigatório | Empresa SiTef. O tamanho é de 8 dígitos alfanuméricos. |
| enderecoSitef | Obrigatório | Endereço dos servidores do SiTef. O campo pode ser composto de 1 a 3 endereços separados por ‘;’. O formato do endereço pode ser: 1. IP, IP:PORTA; 2. Nome do servidor, NOME:PORTA. Caso não seja o TLS Fiserv, o padrão de porta é 4096. Já com o TLS Fiserv, será 443. Obs: Para SmartPOS o Endereço do TLS Fiserv (Produção ou UAT) de acordo com a necessidade do cliente. |
| terminalSitef | Opcional | Número de terminal SiTef. Se não informado o m-SiTef irá usar o número de série do APOS ou o UUID do aparelho Android |
| modalidade | Obrigatório | Funcionalidade da CliSiTef que deseja executar. Por exemplo: 0 – Pagamento 200 – Cancelamento 114 – Reimpressão A lista completa pode ser encontrada no documento “SiTef - Interface Simplificada com a aplicação” na Tabela de códigos de funções. |
| CNPJ_CPF | Obrigatório | CNPJ ou CPF do estabelecimento. Este campo não deve conter caracteres especiais e pode ser utilizado nos dados de subadquirência e no ParmsClient. |
| valor | Obrigatório p/ pagamento | Valor da venda. O campo é numérico com tamanho até 12 algarismos, onde os dois últimos dígitos são decimais. |
| restricoes | Opcional | Opções de pagamento que não aparecerão no fluxo de coleta. O campo deve ter o seguinte formato:<Opção>;<Opção>; ....Os valores das opções estão no documento “SiTef - Interface Simplificada com a aplicação”, na Tabela de códigos de funções. Observação: a opção TransacoesHabilitadas=T1,T2 também pode ser passada nesse parametro e terá preferência sobre o parâmetro TransacoesHabilitadas |
| operador | Opcional | Código do operador. O campo é alfanumérico com tamanho até 20 caracteres. |
| Data | Obrigatório | Data fiscal no formato AAAAMMDD. |
| Hora | Obrigatório | Hora fiscal no formato HHMMSS. |
| numeroCupom | Obrigatório | Número do cupom fiscal correspondente à venda. O campo é alfanumérico com tamanho até 20 caracteres. |
| numParcelas | Opcional | Número de parcelas, em caso de compra parcelada. O campo é numérico e varia de acordo com o cartão utilizado. |
| Otp | Opcional | Código obrigatório quando é utilizada comunicação com TLS GSurf. |
| transacoesHabilitadas | Opcional | Opções de pagamento que serão habilitadas. O campo deve ter o seguinte formato { <Funcionalidade1>;<Funcionalidade2>;...}. Os valores das opções estão no documento “SiTef - Interface Simplificada com a aplicação”, na Tabela de códigos de funções. |
| pinpadMac | Opcional | Endereço MAC Address Bluetooth do Pinpad para o m-SiTef se conectar diretamente com o pinpad. Caso esse parâmetro não seja passado, o m-SiTef apresenta uma lista de dispositivos Bluetooth pareados com o aparelho para o usuário selecionar qual utilizar. Formato: 00:00:00:00:00:00 |
| comExterna | Obrigatório | Campo para definir qual serviço TLS será usado: 0 – Sem (apenas para SiTef dedicado) 1 – TLS Software Express 2 – TLS WNB Comnect 3 – TLS Gsurf 4 - TLS Fiserv (TLS GWP) Obs: Se for Smart POS, é obrigatório passar o campo 4. |
| isDoubleValidation | Obrigatório p/TLS Software Express | Campo para definir qual tipo de validação será usado: 0 – Para validação simples 1 – Para validação dupla |
| cnpj_automacao | Obrigatório | CNPJ da empresa que desenvolveu a automação comercial. Dado utilizado no ParmsClient. |
| cnpj_facilitador | Obrigatório | CNPJ do Facilitador (Van). Dado utilizado no ParmsClient. |
| timeoutColeta | Opcional | Define o tempo de timeout para coletas e interações do fluxo da transação. O valor deve ser preenchido em “segundos” e se não for preenchido, o valor padrão é de 60 segundos. Caso seja definido como 0 ou números negativos, o timeout de coleta será inativado. O timeout é aplicado se o usuário não interagir com a coleta pelo número de segundos especificado. Nesse caso, a transação é automaticamente cancelada e a aplicação recebe o valor RESULT_CANCELED no parâmetro resultCode. Este timeout não se aplica à leitura de QRCode, à coleta do PIN e a retirada do cartão da leitora. |
| acessibilidadeVisual | Opcional | Campo para definir se a acessibilidade visual deve ser habilitada: 0 – Para desabilitar (valor padrão) 1 – Para habilitar A habilitação da acessibilidade visual consiste em algumas modificações visuais e sonoras. Caso este campo seja habilitado, o m-SiTef terá as seguintes alterações: · Fontes maiores para melhor visualização · Alto contraste nas cores para melhor visualização em caso de daltonismo · Ativação do text-to-speech (leitura de tela) durante todo o fluxo · Se for o caso, ativa a adaptação da tela para compatibilidade com a capa de acessibilidade na inserção da senha ou pin (aplicável em modelos pré-definidos). Observação: para que a leitura de tela seja realizada pelo módulo de text-to-speech, o sistema operacional precisa ter previamente instalado o pacote da língua correspondente. No caso do GPOS700, o pacote de linguagem PT-BR será disponibilizado pela Gertec. |
| tipoPinpad | Obrigatório p/ dispositivos USB. | ANDROID_USB – Tenta obter conexão apenas com pinpad´s USB. ANDROID_BT – Tenta obter conexão apenas com pinpad´s Bluetooth. |
| dadosSubAdqui | Opcional | Conjunto de informações complementares que permite que o lojista personalize o que será impresso na fatura do comprador. Formato: <id1><tam1><val1><id2><tam2></tam2><val2>...<idn><tamn></tamn><valn>Onde: Id - identificador do campo com 2 bytes, conforme valores definidos na tabela da especificação ”Informações de Sub-adquirência (Soft Descriptor) Bibliotecas CliSiTefI e CliSiTef” tam - tamanho do campo com 2 bytes. Val – valor do campo. Exemplo de envio: i.putExtra("dadosSubAdqui", "0022STL*SOFTWARE EXPRESS"); Para mais informações referente aos dados consultar a especificação: “Informações de Sub-adquirência (Soft Descriptor) Bibliotecas CliSiTefI e CliSiTef” |
| tipoCampos | Opcional | Permite informar valores pré-determinados para os campos que a CliSiTef solicita para a aplicação durante o fluxo da transação. Os campos e seus respectivos valores devem ser informados no formato JSON abaixo. Os valores sempre deverão ser informados com o valor do tipo String. E é importante observar que nesse formato, é possível definir apenas um valor por tipo de campo. Formato JSON: {"campo1":"val1", "campo2":"val2"..."campon":"valn"}Exemplos de envio: i.putExtra("tipoCampos","{\"147\":\"8000\", \"516\":\"99900021\"}"); i.putExtra("tipoCampos","{\"1025":\"Descricao do Produto\"}"); |
| habilitaColetaTaxaEmbarqueIATA | Opcional | Quando habilitado, indica que se trata de uma transação de venda a crédito IATA e será disponibilizado campo para coleta do valor da taxa de embarque. 0 – Para desabilitar (valor padrão) |
| habilitaColetaValorEntradaIATA | Opcional | Quando habilitado, indica a coleta do valor de entrada em caso de parcelamento da venda a crédito IATA. Esta coleta será permitida apenas para venda IATA, isto é, a habilitação deste item só terá efeito se habilitaColetaTaxaEmbarqueIATA=1. |
| clsit | Opcional | Para poder adicionar, atualizar e remover campos do arquivo de configuração CLSIT do pacote. Olhar seção Mudando o CLSIT. |