API Reference

Roteiro de Venda

Introdução

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

Voucher são produtos digitais que retornam um pin na confirmação de sua venda.

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/voucher/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjU2MzQxNTM2LCJleHAiOjE2NTY1MTQzMzYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.-dnblIvspnmVnS-IQGjZkU3gZcKOr_vX4z1dG_a92hA
Host: sandbox.grupocard.com.br
Content-Length: 239

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"1004","produto":"GOOGLE PLAY RECARGA","tipoProduto":"ONLINE_PIN","fornecedor":"Recarga Google","tipoNegocio":66,"dataHoraCliente":"2022-06-27T13:09:40.244Z","valor":"1000"}

{
   "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
   "idExterno":"1004",
   "produto":"GOOGLE PLAY RECARGA",
   "tipoProduto":"ONLINE_PIN",
   "fornecedor":"Recarga Google",
   "tipoNegocio":66,
   "dataHoraCliente":"2022-06-27T13:09:40.244Z",
   "valor":"1000"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "Recarga Google"
      }
    },
    "transacao": {
      "valor": 1000,
      "status": "AUTORIZADA",
      "idTransacao": "35356039810622",
      "dataHora": "2022-06-27T09:54:44.000-04:00"
    },
    "idExterno": "1004"
  }
}

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/voucher/confirmar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjU2MzQxNTM2LCJleHAiOjE2NTY1MTQzMzYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.-dnblIvspnmVnS-IQGjZkU3gZcKOr_vX4z1dG_a92hA
Host: sandbox.grupocard.com.br
Content-Length: 162

{"idTransacao":"35356039810622","produto":"GOOGLE PLAY RECARGA","dataHoraCliente":"2022-06-27T13:09:40.244Z","estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4"}

{
   "idTransacao":"35356039810622",
   "produto":"GOOGLE PLAY RECARGA",
   "dataHoraCliente":"2022-06-27T13:09:40.244Z",
   "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4"
}

Exemplo de RESPONSE:

{
  "transacao": {
    "status": "EFETIVADA",
    "instrucao": "{\"fornecedor\":\"GOOGLE PLAY RECARGA\",\"data\":\"27/06/2022 09:54:44\",\"estabelecimentoEmpresaId\":\"01191874\",\"pin\":\"9SZGTU0GV6GNVUYB\",\"valor\":\"10,00\",\"nsu\":\"35356039810622\",\"numeroSerie\":\"6369331645858056691\",\"grupoEconomico\":\"Codigo distribuido por N2\"}",
    "idTransacao": "35356039810622"
  }
}

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

Exemplo de REQUEST:

POST /venda/voucher/solicitar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjU2MzQxNTM2LCJleHAiOjE2NTY1MTQzMzYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.-dnblIvspnmVnS-IQGjZkU3gZcKOr_vX4z1dG_a92hA
Host: sandbox.grupocard.com.br
Content-Length: 239

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"1007","produto":"GOOGLE PLAY RECARGA","tipoProduto":"ONLINE_PIN","fornecedor":"Recarga Google","tipoNegocio":66,"dataHoraCliente":"2022-06-27T13:09:40.244Z","valor":"1000"}

{
   "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
   "idExterno":"1007",
   "produto":"GOOGLE PLAY RECARGA",
   "tipoProduto":"ONLINE_PIN",
   "fornecedor":"Recarga Google",
   "tipoNegocio":66,
   "dataHoraCliente":"2022-06-27T13:09:40.244Z",
   "valor":"1000"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "Recarga Google"
      }
    },
    "transacao": {
      "valor": 1000,
      "status": "AUTORIZADA",
      "idTransacao": "35356039890622",
      "dataHora": "2022-06-27T10:03:26.000-04:00"
    },
    "idExterno": "1007"
  }
}

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/voucher/cancelar HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNmQwZjQyYzQtMWNjOS01ODNmLWE3N2QtZDI0ZmI0NGFjYTdhIiwiaWF0IjoxNjU2MzQxNTM2LCJleHAiOjE2NTY1MTQzMzYsIm5hbWUiOiJBZG1pbmlzdHJhdG9yIn0.-dnblIvspnmVnS-IQGjZkU3gZcKOr_vX4z1dG_a92hA
Host: sandbox.grupocard.com.br
Content-Length: 118

{"estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"1007","dataHoraCliente":"2022-06-27T13:09:40.244Z"}

{
   "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
   "idExterno":"1007",
   "dataHoraCliente":"2022-06-27T13:09:40.244Z"
}

Exemplo de RESPONSE:

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