Introdução

Nesta seção apresentamos o roteiro de vendas para os produtos de ESIM, para obter as informações dos produtos utilizados na venda realize a operação Consultar Produtos disponível no anexo de Consultas.

Consultar Planos

Utilize essa operação para obter os valores disponíveis para os planos ESIM.

Obs.: Deve ser guardar os valores {servicoId}, {recarga} de acordo com o layout para se utilizar na solicação de venda.

Como utilizar a operação

Exemplo de RESQUEST:

GET /venda/esim/consulta-planos/81AA1C20B1688E4C7424C4E000334DD4/ESIM%20CLARO HTTP/1.1
Accept: application/json
Host: sandbox.grupocard.com.br

Exemplo de Layout da resposta da consulta:

{
    chave = "{nome} - {internet} - R$ {preco}",
    valor = "{servicoId};{preco};{recarga}"
}

Exemplo de RESPONSE:

{
    "tipoValor": 1,
    "valores": [
        {
            "chave": "Claro Pré-pago Oferta mensal + YouTube - 12GB - R$ 49,90",
            "valor": "vtxprepagochipom12;4990;3000"
        }
    ]
}

Fluxo de sucesso

1 - Consumir a operação Solicitar Venda:

Utilize essa operação para solicitar a venda de produto disponível no estabelecimento.

Obs.: O campo "idExterno" é o identificador da requisição, sendo assim, deve ser enviado com um valor DIFERENTE a cada requisição.

Exemplo de REQUEST:

POST /venda/esim/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer {JWT_TOKEN}
Host: sandbox.grupocard.com.br
Content-Length: 224

{
    "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
    "produto": "ESIM CLARO",
    "idExterno": "teste123",
    "consumidor": {
      "cpf": "00000000000",
      "nome": "some text",
      "email": "[email protected]",
      "nascimento": "13111997",
      "telefone": 21999999999,
      "endereco": {
        "tipoEnderecoId": 1,
        "cep": "79.023-902",
        "uf": "SP",
        "cidade": "São Paulo",
        "bairro": "Vila Olímpia",
        "tipoLogradouroId": 155,
        "logradouro": "Funchal",
        "numeroLogradouro": 100,
        "complemento": "Sala 501"
      }
    },
    "endereco": {
      "tipoEnderecoId": 1,
      "cep": "79.023-902",
      "uf": "SP",
      "cidade": "São Paulo",
      "bairro": "Vila Olímpia",
      "tipoLogradouroId": 155,
      "logradouro": "Funchal",
      "numeroLogradouro": 100,
      "complemento": "Sala 501"
    },
    "servicoId": "vtxprepagochipom12",
    "valorRecarga": 3000,
    "urlCallback": "http://urlCallback.com.br/receberNotificacao",
    "urlRecarga": "http://urlRecarga.com.br/receberNotificacao",
    "dataHoraCliente": "2025-02-03T18:20:35.709Z",
    "valor": "3000"
  }

Exemplo de RESPONSE:

{
    "venda": {
        "estabelecimento": {
            "cnpjCpf": "14.134.409/0001-05",
            "nome": "LOJA GCARD"
        },
        "produto": {
            "fornecedor": {
                "nome": "Vertex Esim"
            }
        },
        "transacao": {
            "valor": 3000,
            "status": "AUTORIZADA",
            "idTransacao": "{idTransacao}",
            "dataHora": "{dataHora}"
        }
    }
}

2 - Confirmação de Venda

Nesse produto não há solicitação de confirmação de venda, ao invés disso, há um chamada callback POST enviado no endereço informado no atributo urlCallback e urlRecarga do campo 'complemento' do payload de recarga. Para que haja um fluxo correto de recebimento das notificações o endpoint informado como callback no atributo deve retornar um código de status http 200 e assim o callback entenderá que não deve enviar mais notificações.

2.1 - Campos de url de callback no envio da oportunidade:

urlCallback: url para notificação após efetivação
urlRecarga: url para notificação após a recarga - opcional (Se optar em receber a notificação de recarga em outro endpoint)

2.2 - Body de Notificação de Callback:

Campo	Obrigatório	Descrição
`uuid`	S	NSU da transação
`msisdn`	S	Número de telefone retornado pelo callback
`url`	S	URL do comprovante
`situacaoTransacao`	S	Situação da transação (EFETIVADA, CANCELADA, PENDENTE, NEGADA)
`promocaoAtivada`	N	Situação da ativação da promoção (SIM, NAO)
`situacaoRecarga`	N	Situação da transação de recarga (SEM RECARGA, SUCESSO, FALHA)
`nsuRecarga`	N	NSU da transação de recarga

obs. Serão enviados no mínimos 2 callbacks, sendo o primeiro após a resolução da venda e o segundo depois da tentativa de recarga.