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âmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
Authorization | Assinatura 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 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
esitef-homologacao.softwareexpress.com.br
Resposta:
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
esitef-homologacao.softwareexpress.com.br
Resposta:
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
esitef-homologacao.softwareexpress.com.br
Resposta:
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
esitef-homologacao.softwareexpress.com.br
Resposta:
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). 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.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. 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) |
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. 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) |
Mc | Menu 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> |
M0 | Menu 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 – Sim2 – NãoExemplo de exibição de Menu Livre tipo 0: Sim Não |