Serviço de listagem de concessionárias

Detalhes da chamada

  • Recurso: /v3/rechargedealers
  • Método HTTP: GET
  • Formato da requisição: query string
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoFormatoObrigatório
AuthorizationAssinatura de autenticidade no formato Bearer {assinatura}. Saiba mais.

Exemplo: Bearer hh39458f73hf45324765ft349h5f73t4h95f34.

Este campo é obrigatório caso a transação tenha sido criada pelo processo de assinatura.		< 2000 ANCOND.

Exemplos

Abaixo estão exemplos de chamada do serviço de listagem de concessionárias utilizando a ferramenta cURL.

Listagem de concessionárias de recarga normal

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/v3/rechargedealers?nit=asdfghjk12345678asdfghjk12345678asdfghjk12345678asdfghjk12345678&generalhash=0000000000000000"
--verbose

Resposta:

{
   "list_dealers_response":{
      "status":"NOV",
      "esitef":{
         "message":"OK. Transaction successful.",
         "code":"0"
      },
      "authorizer":{
         "message":"",
         "code":"000"
      },
      "hashes":{
         "general":"09A9681D09A9681D"
      },
      "dealers":[
         {
            "name":"Vivo",
            "code":"001"
         },
         {
            "name":"Claro",
            "code":"002"
         },
         {
            "name":"Oi",
            "code":"003"
         },
         {
            "name":"Tim",
            "code":"004"
         }
      ]
   }
}

Listagem de concessionárias de recarga de outros produtos (others)

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/v3/rechargedealers?nit=asdfghjk12345678asdfghjk12345678asdfghjk12345678asdfghjk12345678"
--verbose

Resposta:

{
   "list_dealers_response":{
      "status":"NOV",
      "esitef":{
         "message":"OK. Transaction successful.",
         "code":"0"
      },
      "authorizer":{
         "message":"",
         "code":"000"
      },
      "hashes":{
         "general":"09A9681D09A9681D"
      },
      "dealers":[
         {
            "name":"Vex-PIN",
            "code":"905",
            "branches":[
               {
                  "name":"Vex-PIN",
                  "code":"97200000000"
               }
            ],
            "type_name":"PIN TELEFONE",
            "type_code":"02"
         },
         {
            "name":"TIM-Leste-PIN",
            "code":"902",
            "branches":[
               {
                  "name":"TIM-Leste-PIN",
                  "code":"97001000000"
               }
            ],
            "type_name":"PIN TELEFONE",
            "type_code":"02"
         },
         {
            "name":"E-Prepag",
            "code":"901",
            "branches":[
               {
                  "name":"Brancaleone-Migux",
                  "code":"98000000000"
               },
               {
                  "name":"HABBO HOTEL-Habbo Hotel",
                  "code":"98001000000"
               },
               {
                  "name":"ONGAME-Metin2",
                  "code":"98006000000"
               }
            ],
            "type_name":"PIN GAMES",
            "type_code":"03"
         },
         {
            "name":"Prepag",
            "code":"900",
            "branches":[
               {
                  "name":"Level Up!",
                  "code":"99000000000"
               },
               {
                  "name":"OnGame",
                  "code":"99100000000"
               },
               {
                  "name":"Acclaim",
                  "code":"99300000000"
               }
            ],
            "type_name":"PIN GAMES",
            "type_code":"03"
         },
         {
            "name":"Crianca Esperanca",
            "code":"908",
            "branches":[
               {
                  "name":"Crianca Esperanca",
                  "code":"97299000000"
               }
            ],
            "type_name":"DOACAO",
            "type_code":"04"
         },
         {
            "name":"Sorte Mania",
            "code":"909",
            "branches":[
               {
                  "name":"Sorte Mania",
                  "code":"97298000000"
               }
            ],
            "type_name":"SEGURO",
            "type_code":"05"
         }
      ]
   }
}

Listagem de concessionárias de pagamento de fatura por assinatura (invoice)

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/v3/rechargedealers?nit=asdfghjk12345678asdfghjk12345678asdfghjk12345678asdfghjk12345678"
--verbose

Resposta:

{
    "list_dealers_response": {
        "status": "NOV",
        "esitef": {
            "message": "OK. Transaction successful.",
            "code": "0"
        },
        "authorizer": {
            "message": "",
            "code": "000"
        },
        "hashes": {
            "general": "85E791AD85E791AD"
        },
        "dealers": [
            {
                "name": "Vivo SP Pos",
                "code": "800",
                "branches": [
                    {
                        "name": "Vivo SP Pos",
                        "code": "80019000000"
                    }
                ]
            }
        ],
        "questions": [
            {
                "id": "LPERG:126",
                "display": "Identificação do cliente ou Número de contrato",
                "rule": "0",
                "min": "1",
                "max": "11",
                "type": "N"
            }
        ]
    }
}

Listagem de concessionárias com envio de assinatura

Requisição:

curl
--request GET "https://esitef-homologacao.softwareexpress.com.br/e-sitef/v3/rechargedealers?nit=asdfghjk12345678asdfghjk12345678asdfghjk12345678asdfghjk12345678&generalhash=0000000000000000"
--header "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXJjaGFudF9pZCI6IkxPFGFURVNURSIsIm1lcmNoYW50X2tleSI6IkYxOURFMDAxNzdDMzAxREYyNEE4NjVGMTFBQTlCMjU2N0Y2MDQ4OTFGMEY0NEREQUVGRDY5RTMzOTlFMEI3RTEiLCJvcmRlcl9pZCI6IjEzMDE0ODU4NjYzIiwibWVyY2hhbnRfdXNuIjoiMTQ0NjY4MTAxNiIsInRpbWVzdGFtcCI6IjE2MDUzMDM1ODA5MzEifQ.JoYz8mQ8PZ8MCr5QXygbivAy2x9fvdUEGu_jSeOYF-BtSGm7ZSYWFVokyowabk1FM2NCklubb5eEB_-g9lCi1ntRQ9iqKhdldm-U8pl0V98u7Mv_hR-pcp6MHfqql0T-mhkOv1WkfYO1igck4N6EfsNu9iO126BwgvJQC456WjAUW5jgjRHboc6htvaak9NBs6yRVLNZY03cR9gKtQXMoHeXiCGeNU55_2W1SOeRJPk-OsyBzvVlZBX5RdfUjB2BOdRI7H2TDBBS-GZaMV3b2eS5_84JTySFnriCTXJ-Y1FzBnH60e4fTfAiYy1P_J-j9hyXjLYgtRu8jQd8ITfiFG3h4ZIysb4CA_lJNg_d4YuCqhBiZcpculcbfXlcrcfPV-CpDytfiLz34FDWH0Q7Vlna1YuSNOKPzDIUx1MOMZO9bpwaE6Q3kClkqri92-42yeLoUKH6PUrlMpE3JrfuBelALE4ce7QzCrNjcvoqR_KVmCm6ozBjPn9qY0s7x7qe6ZLur7hNUoX79JdWGZy1-bx8dSqqpLrU0SXbMBqtvch5FvdUkktbkJpZAr7q6e0nR13_mK3RTV7adOEw03E_ocUk__rEmjGDAHMSWGmiPowu14jD1-VZ2Yf8FeoKzHYcXmIbEReTVHshk9faBICMQzMS3SXaqow4WXqULZiLTwc"
--verbose

Resposta:

{
   "list_dealers_response":{
      "status":"NOV",
      "esitef":{
         "message":"OK. Transaction successful.",
         "code":"0"
      },
      "authorizer":{
         "message":"",
         "code":"000"
      },
      "hashes":{
         "general":"09A9681D09A9681D"
      },
      "dealers":[
         {
            "name":"Vivo",
            "code":"001"
         },
         {
            "name":"Claro",
            "code":"002"
         },
         {
            "name":"Oi",
            "code":"003"
         },
         {
            "name":"Tim",
            "code":"004"
         }
      ]
   }
}

Parâmetros de requisição

Na tabela abaixo está a descrição dos parâmetros de requisição do serviço de listagem de concessionárias:

ParâmetroDescriçãoFormatoObrigatório
nitIdentificação da transação de recarga no e-SiTef= 64 ASIM
generalhashCódigo de identificação da versão da tabela com os dados relativos às recargas (operadoras, filiais, faixas de valores, validades dos créditos, dentre outros).

Caso a loja não tenha feito uma recarga anteriormente ou não tenha guardado um valor de generalhash previamente recebido do e-SiTef, o valor: 0000000000000000 pode ser passado ao e-SiTef.

Este campo permite ao lojista saber se ocorreu alteração nos dados da recarga. Isso porque se ocorreu alguma alteração na tabela, o generalhash retornado será diferente do generalhash que o lojista possui. Neste caso, é aconselhável que o lojista efetue as consultas e atualize os valores das operadoras de recarga em sua aplicação.		= 16 ANÃO

Parâmetros de resposta

Em caso de sucesso, o código de resposta HTTP será 200. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de listagem de concessionárias:

ParâmetroDescriçãoFormato
statusStatus da transação de recarga no e-SiTef. Saiba mais.= 3 AN
esitef
codeCódigo de resposta do e-SiTef. Qualquer código diferente de 0(zero) significa falha. Saiba mais.< 4 N
messageMensagem de resposta do e-SiTef.< 500 AN
authorizer
codeCódigo de resposta retornado pela autorizadora< 4 AN
messageMensagem retornada pela autorizadora< 64 AN
hashes
generalCódigo de identificação da tabela com os dados relativos às recargas (operadoras, filiais, faixas de valores, validades dos créditos, dentre outros).= 16 AN
dealers[]
codeCódigo da concessionária/operadora= 3 N
nameNome da concessionária/operadora< 100 AN
dealers[].branches[]
codeCódigo da filial= 11 N
nameNome da filial< 100 AN
questions[]
Este campo agrega uma lista de perguntas para confirmação positiva. As perguntas retornadas devem, obrigatoriamente, ser respondidas pelo usuário e ter suas respostas enviadas ao e-SiTef no passo seguinte (listar dados da filial).
idCódigo de identificação da pergunta< 20 AN
displayTexto da pergunta a ser apresentada< 180 AN
ruleIndica onde os dados devem ser coletados. Saiba mais.< 2 AN
minIndica o tamanho mínimo da resposta< 4 N
maxIndica o tamanho máximo da resposta< 5 N
typeIndica o tipo de dados da resposta a ser coletada. Saiba mais.< 3 AN
min_valueIndica o valor mínimo da resposta< 3 N
max_valueIndica o valor máximo da resposta< 3 N

Retorno do campo questions.rule

RegraDescrição
0Teclado do operador
1PinPad (Não se aplica)
2Leitura de trilha magnética no PIN PAD (Não se aplica)
3Automação (A pergunta não deve ser apresentada ao operador/cliente para a coleta da resposta. Neste caso, a própria automação deve responder à pergunta sem intervenção do operador/cliente).
4Senha supervisor (não PINPAD)
5Teclado do operador com dupla digitação.
O <Display> deve conter dois textos, sendo que o primeiro se refere à requisição para a entrada do dado e o segundo, se refere à confirmação da entrada do dado, que deve ser a mesma da primeira.
Os textos devem estar separados por ; como informado a seguir.

<Display> = Texto para 1ª coleta;Texto para 2ª coleta (confirmação)
6Leitora de código de barras
7Digitação com confirmação (Neste caso, deve ser apresentado uma tela para a confirmação dos dados coletados).

Retorno do campo questions.type

TipoDescrição
AAlfabético.
ANAlfanumérico especial (ans).
LNLetras (não acentuadas) e números.
NxNumérico onde x é o número de casa decimais suportados.
VxValor com x casas decimais.
SMenu tipo Sim/Não.
ScMenu tipo Sim/Não condicional. Caso a entrada seja "Não", deve-se abortar a transação.
MMenu livre.
Neste caso, o campo <Display> terá o seguinte formato: o texto do menu deve estar separado por um caractere | das opções. As opções, por sua vez, devem constituir de índice e texto separados por :, enquanto uma opção é separada pela outra por ^. Ou seja:
<Display> = <Texto Menu>|<opção 1>^<opção 2>^...^<opção N>
Onde,
<Texto Menu> = Texto de cabeçalho do menu (Ex: Escolha a bandeira do cartão)
<Opção N> = <Índice>:<Texto da opção> (Ex: 1:Visa)
McMenu livre com confirmação.
Segue a regra do Menu Livre, onde:
<Display> = <Texto Menu>|<Texto para confirmação>|<opção 1>^<opção 2>^...^<opção N>
M0Menu livre tipo 0 (zero). (Não se aplica)
Segue a regra do Menu Livre com confirmação, porém deve ser suprimida os índices de seleção do menu na exibição e selecionar apenas com as setas do POS.
Exemplo de exibição de Menu Livre:
1 – Sim
2 – Não
Exemplo de exibição de Menu Livre tipo 0:
Sim
Não
← Serviço de criação de recargaServiço de listagem de dados da filial →