API Reference

Roteiro de Venda

Introdução

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

Consultar valor do sorteio

Para se obter o valor do sorteio que será utilizado na venda do produto FAMILHAO DO HUCK deve se consumir antes de qualquer solicitação de venda a operação Consultar valores do sorteio.

Obs. 1: Do campo "valor" de ser extraído os valores para os campos "id_sky" e "valor" da solicitação de venda respectivamente: "id_sky" do valor antes do caracter ";" e "valor" do valor depois do caracter ";". De acordo com o exemplo: "valor": "65e87e7e0a6aff3ee0bb42fe;2000" --> "id_sky": "65e87e7e0a6aff3ee0bb42fe" & "valor": "2000".

Exemplo de REQUEST:

GET /venda/sorteio/familhaodohuck/consulta-valores/81AA1C20B1688E4C7424C4E000334DD4 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzQyMzEwOTA2LCJleHAiOjE3NDI0ODM3MDYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.lDy6Qyk4mKIcyxBJ1WQGA9QOWZBm8yRW1UG0t0b0wHs
Host: sandbox.grupocard.com.br

Exemplo de RESPONSE:

{
  "tipoValor": 1,
  "valores": [
    {
      "chave": "Produto Flex - R$ 20,00",
      "valor": "65e87e7e0a6aff3ee0bb42fe;2000"
    }
  ]
}

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.

Exemplo de REQUEST:

POST /venda/sorteio/familhaodohuck/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzQyMzEwOTA2LCJleHAiOjE3NDI0ODM3MDYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.lDy6Qyk4mKIcyxBJ1WQGA9QOWZBm8yRW1UG0t0b0wHs
Host: sandbox.grupocard.com.br
Content-Length: 226

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"teste-familhao-006","id_sku":"65e87e7e0a6aff3ee0bb42fe","cpf":"674.719.020-35","telefone":"67999998866","dataHoraCliente":"2025-03-18T12:45:00","valor":"2000"}

{
    "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
    "idExterno": "teste-familhao-006",
    "id_sku": "65e87e7e0a6aff3ee0bb42fe",
    "cpf": "674.719.020-35",
    "telefone": "67999998866",
    "dataHoraCliente": "2025-03-18T12:45:00",
    "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 GLOBO"
      }
    },
    "transacao": {
      "valor": 2000,
      "status": "AUTORIZADA",
      "idTransacao": "15a700e0-b29b-4fe8-9f47-29f181a26c2a",
      "dataHora": "2025-03-18T12:45:00.000-04:00"
    },
    "idExterno": "teste-familhao-006"
  }
}

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/familhaodohuck/confirmar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzQyMzEwOTA2LCJleHAiOjE3NDI0ODM3MDYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.lDy6Qyk4mKIcyxBJ1WQGA9QOWZBm8yRW1UG0t0b0wHs
Host: sandbox.grupocard.com.br
Content-Length: 176

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idTransacao":"15a700e0-b29b-4fe8-9f47-29f181a26c2a","produto":"FAMILHAO DO HUCK","dataHoraCliente":"2025-03-18T12:45:00"}

Exemplo de RESPONSE:

{
  "transacao": {
    "status": "EFETIVADA",
    "instrucao": "{\"dataHoraEstabelecimento\":\"18/03/2025 13:05:36\",\"estabelecimentoEmpresaId\":\"1191874\",\"telefone\":\"(67)*****-8866\",\"url\":\"https://www.familhao.com/familhao\",\"valorFormatado\":\"20,00\",\"descricao\":\"Parabéns!! Você acabou de adquirir um pacote de boas notícias!!! Para completar o seu cadastro, resgatar o seu cupom especial e conhecer todos os outros benefícios acesse: www.familhão.com\",\"produtoId\":\"65e87e7e0a6aff3ee0bb42fe\",\"nomeFantasia\":\"Homologacao Plataforma WS recarga Multiproduto - NAO MEXER\",\"dataSorteio\":\"18/03/2025\",\"cpf\":\"***.719.020-**\",\"grupoEconomico\":\"N2\",\"numeroSorte\":\"17009801\",\"mensagens\":\"\",\"produtoNome\":\"Produto Flex\",\"transacaoIdParcial\":\"29F181A26C2A\"}",
    "idTransacao": "15a700e0-b29b-4fe8-9f47-29f181a26c2a"
  }
}

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 cancelamentocancelamento 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.

Exemplo de REQUEST:

POST /venda/sorteio/familhaodohuck/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzQyMzEwOTA2LCJleHAiOjE3NDI0ODM3MDYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.lDy6Qyk4mKIcyxBJ1WQGA9QOWZBm8yRW1UG0t0b0wHs
Host: sandbox.grupocard.com.br
Content-Length: 226

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"teste-familhao-007","id_sku":"65e87e7e0a6aff3ee0bb42fe","cpf":"674.719.020-35","telefone":"67999998866","dataHoraCliente":"2025-03-18T13:10:00","valor":"2000"}

{
    "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
    "idExterno": "teste-familhao-007",
    "id_sku": "65e87e7e0a6aff3ee0bb42fe",
    "cpf": "674.719.020-35",
    "telefone": "67999998866",
    "dataHoraCliente": "2025-03-18T13:10:00",
    "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 GLOBO"
      }
    },
    "transacao": {
      "valor": 2000,
      "status": "AUTORIZADA",
      "idTransacao": "276c654a-ecb8-4110-8ade-959284b454f2",
      "dataHora": "2025-03-18T13:10:00.000-04:00"
    },
    "idExterno": "teste-familhao-007"
  }
}

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/familhaodohuck/cancelar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNzQyMzEwOTA2LCJleHAiOjE3NDI0ODM3MDYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.lDy6Qyk4mKIcyxBJ1WQGA9QOWZBm8yRW1UG0t0b0wHs
Host: sandbox.grupocard.com.br
Content-Length: 127

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"teste-familhao-007","dataHoraCliente":"2025-03-18T13:10:00"}

{
    "estabelecimento": "81AA1C20B1688E4C7424C4E000334DD4",
    "idExterno": "teste-familhao-007",
    "dataHoraCliente": "2025-03-18T13:10:00"
}

Exemplo de RESPONSE:

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