logo Home / Manuais de Utilizaçãov1.0 / Parâmetro de Configuração JSON

Parâmetro de Configuração JSON

Parâmetro de Configuração no formato JSON utilizado para o uso das Funções de Requisição de Venda Acumulativa ou de Venda Digitada via NFC.

#Configuração do Parâmetro de CupomFiscal:

A partir da versão 3.3.0 da Lib SDK Transaction, foi implementada a possibilidade de configurar o CupomFiscal da CliSiTef como um parâmetro na Função de Requisição de Venda Acumulativa. Esse parâmetro oferece flexibilidade ao integrador, permitindo o uso de um CupomFiscal específico durante a transação. A seguir, estão detalhadas as regras de uso e validação desse parâmetro:

  • O CupomFiscal pode ser enviado como um dado adicional (extra data) na transação.

  • O parâmetro CupomFiscal deve ser enviado no JSON como uma String na Função de Requisição de Venda Acumulativa.

  • O valor do CupomFiscal deve conter no máximo 20 caracteres.

  • Caso o parâmetro não seja enviado ou seja enviado vazio (""), o valor padrão "170518" será utilizado.

  • Se o valor enviado estiver em branco ou exceder o limite de 20 caracteres, a operação resultará em um erro de configuração.

Além disso, para o tratamento de pendências, o último CupomFiscal configurado será sempre utilizado automaticamente.

Exemplo de uso:

{
    "cupomFiscal": "1234abcd"
}

#Configuração do Parâmetro de Bloqueio de Tarja Magnética:

A partir da versão 3.7.0 da Lib SDK Transaction, foi implementada a possibilidade de bloquear vendas realizadas com cartão de tarja magnética por meio de um parâmetro na Função de Requisição de Venda Acumulativa. Esse parâmetro oferece maior controle ao integrador, permitindo restringir transações que não utilizem chip ou tecnologia mais segura. A seguir, estão detalhadas as regras de uso e validação desse parâmetro:

  • O parâmetro bloqueiaTarja deve ser enviado no JSON como uma String na Função de Requisição de Venda Acumulativa

  • Quando configurado com o valor "1", caso o cartão seja lido por tarja magnética, a operação será automaticamente cancelada.

  • Nessa situação, será retornado o código de resposta "400", informando que vendas com cartão de tarja magnética não são permitidas

  • Caso o parâmetro não seja enviado ou seja enviado com valor diferente de "1", a leitura por tarja magnética será permitida normalmente.

Exemplo de uso:

{
   "bloqueiaTarja" : "1"
}

#Parâmetros do Configura:

Os Parâmetros do Configura é uma configuração enviada pelo terminal a cada venda realizada.

O parâmetro é composto por 3 dados: “DadosSubAdquirencia”, “CodigoCliente” e “ParmsClient”, que devem ser enviados no formato JSON.

Existem 2 formas de enviá-lo: Por inteiro ou em partes. Não é possível enviar o parâmetro de ambas as formas em uma mesma venda.

#JSON Inteiro:

O JSON por inteiro é composto por apenas um campo no formato String com o nome de “paramConfig”. Desta forma, cada um dos dados devem ser separados por ponto e vírgula “;”.

Exemplo:

#DadosSubAdquirencia:

Os dados de subadquirente são compostos pela tag (vermelho), pelo tamanho (azul) e os dados. Segue abaixo a descrição das tag’s:

Tag: 00
Campo: Nome Fantasia (MerchantName)
Formato: Alfanumérico
Tamanho Máximo: 22

Tag: 01
Campo: Endereço
Formato: Alfanumérico
Tamanho Máximo: 48

Tag: 02
Campo: Cidade
Formato: Alfanumérico
Tamanho Máximo: 13

Tag: 03
Campo: UF
Formato: Alfanumérico
Tamanho Máximo: 2

Tag: 04
Campo: País
Formato: Alfanumérico
Tamanho Máximo: 3

Tag: 05
Campo: CEP
Formato: Alfanumérico
Tamanho Máximo: 10

Tag: 06
Campo: MCC (Merchant Category Code)
Formato: Numérico
Tamanho Máximo: 4

Tag: 07
Campo: CNPJ/CPF
Formato: Numérico
Tamanho Máximo: 14

Tag: 08
Campo: Telefone
Formato: Numérico
Tamanho Máximo: 11

Tag: 09
Campo: Id (Código de Identificação do Estabelecimento)
Formato: Alfanumérico
Tamanho Máximo: 22

Tag: 10
Campo: E-mail
Formato: Alfanumérico
Tamanho Máximo: 99

Tag: 11
Campo: Razão Social/Nome Completo
Formato: Alfanumérico
Tamanho Máximo: 60

Tag: 12
Campo: Tipo de Pessoa (F ou J)
Formato: Alfanumérico
Tamanho Máximo: 1

Tag: 13
Campo: Facilitator Merchant Id
Formato: Alfanumérico
Tamanho Máximo: 15

Exemplo de uso da configuração referente apenas ao dado “DadosSubAdquirencia” no JSON por inteiro:

{
    "paramConfig": "DadosSubAdquirencia=0019GSURF  *Teste Cupom0121Rua Jose Antonio Lobo0208Garopaba0302SC0403BRA05088849500006045566;"
}

#CodigoClient:

É composto pelo CNPJ/CPF da Loja.

Exemplo de uso da configuração referente apenas ao dado “CodigoClient” no JSON por inteiro:

{
    "paramConfig": "CodigoCliente=05643319000159;"
}

#ParmsClient:

É composto pelos campos 1, 2, 3 e 4. O campo 2 será sempre o CNPJ da GSurf e o campo 4 o CNPJ do Parceiro. Já os campos 1 e 3 são alternados, sendo o campo 1 o CNPJ cadastrado na Loja e o campo 3 o CPF cadastrado na Loja.

A formatação deste dado é composta pelo campo (1, 2, 3 ou 4) seguido de um sinal de igual “=”. No final da divisão de cada campo é necessário inserir um ponto e vírgula “;”. Também é necessário que toda a configuração do referido dado esteja dentro de colchetes “[]”.

Exemplo de uso da configuração referente apenas ao dado “ParmsClient” no JSON por inteiro:

{
    "paramConfig": "[ParmsClient=2=05643319000159;3=32482350808]"
}

#JSON em Partes:

Desta forma é possível enviar cada um dos campos separadamente.

Exemplo:

{
    "merchantName": "GSURF  *Teste Cupom",
    "email": "suporte@gsurfnet.com",
    "phone": "4832548700",
    "city": "Garopaba",
    "codeClient": "32482350808",
    "cnpj_company_developer": "05643319000159",
    "cpf_device_owner": "32482350808",
    "cnpj_facilitator": "22269834000130"
}

#DadosSubAdquirencia:

Com o JSON em partes não é necessário enviar a tag e o tamanho dos campos. É necessário apenas enviar o nome correto e respeitar o limite máximo de caracteres conforme a especificação abaixo referente a cada campo:

Nome no JSON: merchantName
Formato: Alfanumérico/String
Tamanho Máximo: 22

Nome no JSON: address
Formato: Alfanumérico/String
Tamanho Máximo: 48

Nome no JSON: city
Formato: Alfanumérico/String
Tamanho Máximo: 13

Nome no JSON: uf
Formato: Alfanumérico/String
Tamanho Máximo: 2

Nome no JSON: country
Formato: Alfanumérico/String
Tamanho Máximo: 3

Nome no JSON: cep
Formato: Alfanumérico/String
Tamanho Máximo: 10

Nome no JSON: mcc
Formato: Numérico/String
Tamanho Máximo: 4

Nome no JSON: cnpj
Formato: Numérico/String
Tamanho Máximo: 14

Nome no JSON: phone
Formato: Numérico/String
Tamanho Máximo: 11

Nome no JSON: id
Formato: Alfanumérico/String
Tamanho Máximo: 22

Nome no JSON: email
Formato: Alfanumérico/String
Tamanho Máximo: 99

Nome no JSON: socialReason
Formato: Alfanumérico/String
Tamanho Máximo: 60

Nome no JSON: personType
Formato: Alfanumérico/String
Tamanho Máximo: 1

Nome no JSON: merchantIdFacilitator
Formato: Alfanumérico/String
Tamanho Máximo: 15

Exemplo de uso da configuração referente apenas ao dado “DadosSubAdquirencia” no JSON em partes:

{
    "merchantName": "GSURF  *Teste Cupom",
    "email": "suporte@gsurfnet.com",
    "phone": "4832548700",
    "city": "Garopaba"
}

#CodigoClient:

É composto pelo CNPJ/CPF da Loja.

Exemplo de uso da configuração referente apenas ao dado “CodigoClient” no JSON em partes:

{
    "codeClient": "32482350808"
}

#ParmsClient:

É possível enviar os 4 campos referentes ao referido dado de maneira separada e respeitando o limite máximo de caracteres conforme a especificação abaixo referente a cada campo:

Campo 1:
Nome no JSON: cnpj_merchant
Formato: Numérico/String
Tamanho: 14

Campo 2:
Nome no JSON: cnpj_company_developer
Formato: Numérico/String
Tamanho: 14

Campo 3:
Nome no JSON: cpf_device_owner
Formato: Numérico/String
Tamanho: 11

Campo 4:
Nome no JSON: cnpj_facilitator
Formato: Numérico/String
Tamanho: 14

Exemplo de uso da configuração referente apenas ao dado “ParmsClient” no JSON em partes:

{
    "cnpj_company_developer": "05643319000159",
    "cpf_device_owner": "32482350808",
    "cnpj_facilitator": "22269834000130"
}

#Parâmetros do Efetua:

Os Parâmetros do Efetua são parâmetros adicionais passados no início de cada venda. Um exemplo de um parâmetro adicional é desabilitar a mensagem de retirar o cartão do fluxo transacional.

O campo deste JSON possui o nome de “paramEfetu”. Cada parâmetro de configuração deve estar entre chaves “{}” e contendo ponto e vírgula “;” no final de cada um.

Exemplo:

{
    "paramEfetu": "{Parametro1};{Parametro2};"
}

Além disso, também é possível configurar um fluxo direto para um tipo específico de transação. Nesse caso, os códigos de meios de pagamento, configurações e menus informados pela Fiserv podem ser ignorados no fluxo, utilizando-se colchetes "[]", com os códigos separados por ponto e vírgula ";".

Abaixo seguem exemplos de utilização para cada tipo de transação:

Venda de crédito à vista (chip/magnético):

{
    "paramEfetu": "[7;8;10;14;15;16;17;18;19;20;21;24;27;28;29;31;32;33;36;60;61;3003;3004;3020;3031;3041;3203;3319;3320;3349;3582;3583;3626;3652;3759;3988];"
}

Venda de crédito parcelado pelo estabelecimento/loja (chip/magnético):

{
    "paramEfetu": "[7;8;10;14;15;16;17;18;19;20;21;24;26;28;29;31;32;33;36;60;61;3003;3004;3020;3031;3041;3203;3319;3320;3349;3582;3583;3626;3652;3759;3988];"
}

Venda de crédito parcelado pela administradora (chip/magnético):

{
    "paramEfetu": "[7;8;10;14;15;16;17;18;19;20;21;24;26;27;29;31;32;33;36;60;61;3003;3004;3020;3031;3041;3203;3319;3320;3349;3582;3583;3626;3652;3759;3988];"
}

Venda de débito à vista (chip/magnético):

{
    "paramEfetu": "[7;8;10;14;17;18;19;20;21;24;25;26;27;28;29;31;32;33;36;42;60;61;3003;3004;3020;3031;3041;3203;3319;3320;3349;3582;3583;3626;3652;3759;3988];"
}

Observação: A configuração acima foi adaptada com base nos códigos de transações desabilitadas presentes no CLSIT recebido do Servidor em Homolog no Parceiro gsurf, podendo apresentar variações em outros ambientes.

Outra configuração possível nos Parâmetros do Efetua é a utilização do parâmetro "SomenteTransacoesSeguras", que permite controlar a obrigatoriedade da coleta de senha do cartão durante a venda acumulativa.

Quando configurado com o valor "1", não será permitida a realização de transações sem a coleta da senha do cartão. Caso o parâmetro não seja informado, assume-se automaticamente o valor "0", permitindo transações sem a obrigatoriedade de senha.

Exemplo de uso:

{
"paramEfetu" : "{SomenteTransacoesSeguras=1};"
}