Servi�o de listagem de concession�rias
import ApiDoc from '../../src/components/api-doc/ApiDoc';
Detalhes da chamada
<ApiDoc method="get" path="/e-sitef/api/v3/rechargedealers" />
- Recurso:
/v3/rechargedealers - M�todo HTTP:
GET - Formato da requisi��o:
query string - Formato da resposta:
JSON - Par�metros de cabe�alho:
| Par�metro | Descri��o | Formato | Obrigat�rio |
|---|---|---|---|
Authorization | Assinatura de autenticidade no formato Bearer {assinatura}. Saiba mais.<br/><br/>Exemplo: Bearer {TOKEN_JWT_EXAMPLE}.<br/><br/>Este campo � obrigat�rio caso a transa��o tenha sido criada pelo processo de assinatura. | < 2000 AN | COND. |
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:
Para usar este exemplo, n�o esquecer de definir a vari�vel {{url}} com o valor<br/> <URLPOSTMAN/>
curl
--request GET "https://{{url}}/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:
Para usar este exemplo, n�o esquecer de definir a vari�vel {{url}} com o valor<br/> <URLPOSTMAN/>
curl
--request GET "https://{{url}}/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:
Para usar este exemplo, n�o esquecer de definir a vari�vel {{url}} com o valor<br/> <URLPOSTMAN/>
curl
--request GET "https://{{url}}/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:
Para usar este exemplo, n�o esquecer de definir a vari�vel {{url}} com o valor<br/> <URLPOSTMAN/>
curl
--request GET "https://{{url}}/e-sitef/v3/rechargedealers?nit=asdfghjk12345678asdfghjk12345678asdfghjk12345678asdfghjk12345678&generalhash=0000000000000000"
--header "Authorization: Bearer {TOKEN_JWT_EXAMPLE}"
--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�metro | Descri��o | Formato | Obrigat�rio |
|---|---|---|---|
nit | Identifica��o da transa��o de recarga no Carat | = 64 A | SIM |
generalhash | C�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).<br/><br/>Caso a loja n�o tenha feito uma recarga anteriormente ou n�o tenha guardado um valor de generalhash previamente recebido do Carat, o valor: 0000000000000000 pode ser passado ao Carat.<br/><br/>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 A | N�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�metro | Descri��o | Formato |
|---|---|---|
status | Status da transa��o de recarga no Carat. Saiba mais. | = 3 AN |
| esitef | ||
code | C�digo de resposta do Carat. Qualquer c�digo diferente de 0(zero) significa falha. Saiba mais. | < 4 N |
message | Mensagem de resposta do Carat. | < 500 AN |
| authorizer | ||
code | C�digo de resposta retornado pela autorizadora | < 4 AN |
message | Mensagem retornada pela autorizadora | < 64 AN |
| hashes | ||
general | C�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[] | ||
code | C�digo da concession�ria/operadora | = 3 N |
name | Nome da concession�ria/operadora | < 100 AN |
| dealers[].branches[] | ||
code | C�digo da filial | = 11 N |
name | Nome 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 Carat no passo seguinte (listar dados da filial). | |
id | C�digo de identifica��o da pergunta | < 20 AN |
display | Texto da pergunta a ser apresentada | < 180 AN |
rule | Indica onde os dados devem ser coletados. Saiba mais. | < 2 AN |
min | Indica o tamanho m�nimo da resposta | < 4 N |
max | Indica o tamanho m�ximo da resposta | < 5 N |
type | Indica o tipo de dados da resposta a ser coletada. Saiba mais. | < 3 AN |
min_value | Indica o valor m�nimo da resposta | < 3 N |
max_value | Indica o valor m�ximo da resposta | < 3 N |
Retorno do campo questions.rule
| Regra | Descri��o |
|---|---|
0 | Teclado do operador |
1 | PinPad (N�o se aplica) |
2 | Leitura de trilha magn�tica no PIN PAD (N�o se aplica) |
3 | Automa��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). |
4 | Senha supervisor (n�o PINPAD) |
5 | Teclado do operador com dupla digita��o.<br/>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.<br/>Os textos devem estar separados por ; como informado a seguir.<br/><br/><Display> = Texto para 1� coleta;Texto para 2� coleta (confirma��o) |
6 | Leitora de c�digo de barras |
7 | Digita��o com confirma��o (Neste caso, deve ser apresentado uma tela para a confirma��o dos dados coletados). |
Retorno do campo questions.type
| Tipo | Descri��o |
|---|---|
A | Alfab�tico. |
AN | Alfanum�rico especial (ans). |
LN | Letras (n�o acentuadas) e n�meros. |
Nx | Num�rico onde x � o n�mero de casa decimais suportados. |
Vx | Valor com x casas decimais. |
S | Menu tipo Sim/N�o. |
Sc | Menu tipo Sim/N�o condicional. Caso a entrada seja "N�o", deve-se abortar a transa��o. |
M | Menu livre.<br/>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:<br/><Display> = <Texto Menu>|<op��o 1>^<op��o 2>^...^<op��o N><br/>Onde,<br/><Texto Menu> = Texto de cabe�alho do menu (Ex: Escolha a bandeira do cart�o)<br/><Op��o N> = <�ndice>:<Texto da op��o> (Ex: 1:Visa) |
Mc | Menu livre com confirma��o.<br/>Segue a regra do Menu Livre, onde:<br/><Display> = <Texto Menu>|<Texto para confirma��o>|<op��o 1>^<op��o 2>^...^<op��o N> |
M0 | Menu livre tipo 0 (zero). (N�o se aplica)<br/>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.<br/>Exemplo de exibi��o de Menu Livre:<br/>1 � Sim<br/>2 � N�o<br/>Exemplo de exibi��o de Menu Livre tipo 0:<br/>Sim<br/>N�o |