API Reference

Roteiro de Venda

Introdução

Nesta seção apresentamos o roteiro de vendas para os produtos Palpite do Milhão. Para obter as informações do produto que serão utilizadas realize a operação Consultar Produtos disponível no anexo de Consultas

Fluxo de sucesso

1 - Consumir a operação Solicitar Venda:

Utilize essa operação para solicitar a venda de qualquer produto disponível no estabelecimento. Este serviço faz apenas a SOLICITAÇÃO da venda, portanto, se na resposta desta operação o campo "status" for igual a AUTORIZADA, na sequência a confirmação da transação deve ser enviada através da operação a seguir: Confirmar Venda.

Obs. 1: Se ao invocar essa operação o cliente não obter uma resposta, é ALTAMENTE RECOMENDADO que seja realizado o cancelamento da solicitação.

Obs. 2: A representação dos centavos no campo "valor" não deve ter separação por virgula. Ex: R$10,99 = 1099

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

Obs.4: Os valores dos campos cpf, telefone e dataNascimento podem ser enviados com ou sem máscara de formatação.

Exemplo de REQUEST:

POST /venda/sorteio/palpitedomilhao/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzA1NTg5MTI5LCJleHAiOjE3MDU3NjE5MjksIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.FSVyCwx15Tx7n1cmNwNc3-4Z7pGSrneSOzaStNvkbek
Host: sandbox.grupocard.com.br
Content-Length: 238

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","produto":"FST 1 SEM","idExterno":"testePDM01","cpf":"205.577.740-80","telefone":"67999999999","dataNascimento":"01/01/2000","dataHoraCliente":"2024-01-18T10:47:56.373Z","valor":"500"}

{
  "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
  "produto": "FST 1 SEM",
  "idExterno": "testePDM01",
  "cpf": "205.577.740-80",
  "telefone": "67999999999",
  "dataNascimento": "01/01/2000",
  "dataHoraCliente": "2024-01-18T10:47:56.373Z",
  "valor": "500"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "REDE TV"
      }
    },
    "transacao": {
      "valor": 500,
      "status": "AUTORIZADA",
      "instrucao": "{\"textoPromocao\":[\\\"Parabens por assinar o Festival de Premios!\",\"\",\"PROMOCAO PALPITE DO MILHAO\",\"\",\"Voce esta concorrendo a\",\"R$1.000.000,00 e outros premios.\",\"A apuracao sera no(s) dia(s):\",\"26/11/2023;03/12/2023;10/12/2023;17/12/2023, domingo, as 20:30, na REDETV!\",\"\",\"Essas sao as suas 6 duplas da sorte:\",\"\",\"1.LUCIANA+TV\",\"2.JOAO+CAMERA\",\"3.DANIELA+CONTROLE\",\"4.NELSON+MICROFONE\",\"5.SONIA+LUZ\",\"6.OPERACAO DE RISCO+SUPERPOP\",\"Boa sorte!\",\"\",\"Se preferir mudar as duplas, se descadastrar ou consultar os regulamentos e os certificados de autorizacao SRE/MF acesse www.palpitedomilhao.com.br ou www.festivaldepremios.com.br.\",\"Participacao para maiores de 18 anos.\\\"],\"dataNascimento\":\"01/01/2000\",\"telefoneWs\":\"informacao indisponivel\",\"produtoId\":4268,\"nomeFantasia\":\"Homologacao Plataforma WS recarga Multiproduto - NAO MEXER\",\"nsuWs\":\"e4fcfd33-d658-47ce-b60f-2d32598d5092\",\"nomeFornecedor\":\"REDE TV\",\"cpf\":\"205.577.740-80\",\"produtoNome\":\"UmaSemana\",\"estabelecimentoId\":809169,\"qrCodeText\":\"https://www.festivaldepremios.com.br/pdv/c8392db5-1b85-4837-a111-fbd08806a6b0\",\"instrucao\":\"Agora voce ja esta concorrendo a premios, acesse atraves do QrCode e finalize o seu cadastro para obter mais infromacoes\",\"dataCadastro\":\"27/11/2023 12:48\"}",
      "idTransacao": "e4fcfd33-d658-47ce-b60f-2d32598d5092",
      "dataHora": "2024-01-18T11:03:58.000-04:00"
    },
    "idExterno": "testePDM01"
  }
}

2 - Consumir a operação Confirmar Venda

Utilize essa operação para efetivar/confirmar uma transação de venda solicitada anteriormente pela operação Solicitar Venda.

Obs. 1: A transação uma vez sendo Confirmada, seu status não poderá mais ser alterado, e mesmo que a operação seja invocada para tal ação, não surtirá efeito!

Exemplo de REQUEST:

POST /venda/sorteio/palpitedomilhao/confirmar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzA1NTg5MTI5LCJleHAiOjE3MDU3NjE5MjksIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.FSVyCwx15Tx7n1cmNwNc3-4Z7pGSrneSOzaStNvkbek
Host: sandbox.grupocard.com.br
Content-Length: 174

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idTransacao":"e4fcfd33-d658-47ce-b60f-2d32598d5092","produto":"FST 1 SEM","dataHoraCliente":"2024-01-18T10:47:56.373Z"}

{
  "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
  "idTransacao": "e4fcfd33-d658-47ce-b60f-2d32598d5092",
  "produto": "FST 1 SEM",
  "dataHoraCliente": "2024-01-18T10:47:56.373Z"
}

Exemplo de RESPONSE:

{
  "transacao": {
    "status": "EFETIVADA",
    "idTransacao": "e4fcfd33-d658-47ce-b60f-2d32598d5092"
  }
}

Fluxo de cancelamento

1 - Consumir a operação Solicitar Venda:

Utilize essa operação para solicitar a venda de qualquer produto disponível no estabelecimento. Este serviço faz apenas a SOLICITAÇÃO da venda, portanto, se na resposta desta operação o campo "status" for igual a AUTORIZADA, na sequência a confirmação da transação deve ser enviada através da operação a seguir: Confirmar Venda

Obs. 1: Se ao invocar essa operação o cliente não obter uma resposta, é ALTAMENTE RECOMENDADO que seja realizado o cancelamento da solicitação.

Obs. 2: A representação dos centavos no campo "valor" não deve ter separação por virgula. Ex: R$10,99 = 1099

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

Obs.4: Os valores dos campos cpf, telefone e dataNascimento podem ser enviados com ou sem máscara de formatação.

Exemplo de REQUEST:

POST /venda/sorteio/palpitedomilhao/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzA1NTg5MTI5LCJleHAiOjE3MDU3NjE5MjksIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.FSVyCwx15Tx7n1cmNwNc3-4Z7pGSrneSOzaStNvkbek
Host: sandbox.grupocard.com.br
Content-Length: 239

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","produto":"FST 4 SEM","idExterno":"testePDM02","cpf":"205.577.740-80","telefone":"67999999999","dataNascimento":"01/01/2000","dataHoraCliente":"2024-01-18T11:08:56.373Z","valor":"2000"}

{
  "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
  "produto": "FST 4 SEM",
  "idExterno": "testePDM02",
  "cpf": "205.577.740-80",
  "telefone": "67999999999",
  "dataNascimento": "01/01/2000",
  "dataHoraCliente": "2024-01-18T11:08:56.373Z",
  "valor": "2000"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "REDE TV"
      }
    },
    "transacao": {
      "valor": 2000,
      "status": "AUTORIZADA",
      "instrucao": "{\"textoPromocao\":[\\\"Parabens por assinar o Festival de Premios!\",\"\",\"PROMOCAO PALPITE DO MILHAO\",\"\",\"Voce esta concorrendo a\",\"R$1.000.000,00 e outros premios.\",\"A apuracao sera no(s) dia(s):\",\"26/11/2023;03/12/2023;10/12/2023;17/12/2023, domingo, as 20:30, na REDETV!\",\"\",\"Essas sao as suas 6 duplas da sorte:\",\"\",\"1.LUCIANA+TV\",\"2.JOAO+CAMERA\",\"3.DANIELA+CONTROLE\",\"4.NELSON+MICROFONE\",\"5.SONIA+LUZ\",\"6.OPERACAO DE RISCO+SUPERPOP\",\"Boa sorte!\",\"\",\"Se preferir mudar as duplas, se descadastrar ou consultar os regulamentos e os certificados de autorizacao SRE/MF acesse www.palpitedomilhao.com.br ou www.festivaldepremios.com.br.\",\"Participacao para maiores de 18 anos.\\\"],\"dataNascimento\":\"01/01/2000\",\"telefoneWs\":\"informacao indisponivel\",\"produtoId\":4269,\"nomeFantasia\":\"Homologacao Plataforma WS recarga Multiproduto - NAO MEXER\",\"nsuWs\":\"3d2a3b0f-fbbc-4165-8d13-7871c93c07ca\",\"nomeFornecedor\":\"REDE TV\",\"cpf\":\"205.577.740-80\",\"produtoNome\":\"UmaSemana\",\"estabelecimentoId\":809169,\"qrCodeText\":\"https://www.festivaldepremios.com.br/pdv/c8392db5-1b85-4837-a111-fbd08806a6b0\",\"instrucao\":\"Agora voce ja esta concorrendo a premios, acesse atraves do QrCode e finalize o seu cadastro para obter mais infromacoes\",\"dataCadastro\":\"27/11/2023 12:48\"}",
      "idTransacao": "3d2a3b0f-fbbc-4165-8d13-7871c93c07ca",
      "dataHora": "2024-01-18T11:08:16.000-04:00"
    },
    "idExterno": "testePDM02"
  }
}

2 - Consumir a operação Cancelar Venda

Utilize essa operação para cancelar uma transação de venda solicitada anteriormente pela operação Solicitar Venda.

Obs. 1: A transação uma vez sendo Cancelada, seu status não poderá mais ser alterado, e mesmo que a operação seja invocada para tal ação, não surtirá efeito!

Exemplo de REQUEST:

POST /venda/sorteio/palpitedomilhao/cancelar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzA1NTg5MTI5LCJleHAiOjE3MDU3NjE5MjksIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.FSVyCwx15Tx7n1cmNwNc3-4Z7pGSrneSOzaStNvkbek
Host: sandbox.grupocard.com.br
Content-Length: 124

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"testePDM02","dataHoraCliente":"2024-01-18T11:08:56.373Z"}

{
  "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
  "idExterno": "testePDM02",
  "dataHoraCliente": "2024-01-18T11:08:56.373Z"
}

Exemplo de RESPONSE:

{
  "transacao": {
    "status": "CANCELADA"
  }
}