API Reference

Roteiro de Venda

Introdução

Nesta seção apresentamos o roteiro de vendas para o produto MS CAP. 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 MS CAP, deve se consumir antes de qualquer solicitação de venda a operação Consultar valores do sorteio no campo "valor".

Exemplo de REQUEST:

GET /venda/sorteio/mscap/consulta-sorteios/81AA1C20B1688E4C7424C4E000334DD4 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvc2FuZGJveC5ncnVwb2NhcmQuY29tLmJyIiwic3ViIjoiNzk3OGI0MzItYzdhYS01MzJhLTgyMjAtMDIxNzlkZWUyZmMwIiwiaWF0IjoxNjUzOTE4NzM1LCJleHAiOjE2NTQwOTE1MzUsIm5hbWUiOiJhZG1pbiJ9.QfKg_PWXaPlf9_pRzH6ZTBPOTH7vwEXdxSQ2Vi0AVh4
Host: sandbox.grupocard.com.br

Exemplo de RESPONSE:

{
  "tipoValor": 3,
  "valores": [
    {
      "chave": "05/06 - R$10",
      "valor": "1000"
    }
  ]
}

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/mscap/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: 199

{"valor":"1000","estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"1026","cep":"79063-640","cpf":"755.546.001-74","telefone":"67999999999","dataHoraCliente":"2022-06-27T13:09:40.244Z"}

{
   "valor":"1000",
   "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
   "idExterno":"1026",
   "cep":"79063-640",
   "cpf":"755.546.001-74",
   "telefone":"67999999999",
   "dataHoraCliente":"2022-06-27T13:09:40.244Z"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "MS CAP"
      }
    },
    "transacao": {
      "valor": 1000,
      "status": "AUTORIZADA",
      "instrucao": "{\"estabelecimento\":\"1191874\",\"payload\":{\"idPromocao\":4188,\"dataSorteioPrincipal\":\"03/07/2022 09:00:00\",\"tituloPromocao\":\"3x10 MIL \\\\1 T-CROSS + 30 MIL \\\\20xMIL \",\"sorteios\":[{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"10 MIL REAIS - Valor liquido\",\"ordem\":1},{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"10 MIL REAIS - Valor liquido\",\"ordem\":2},{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"10 MIL REAIS - Valor liquido\",\"ordem\":3},{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"1 T-CROSS 0KM + 30 MIL REAIS - Sugestao de uso do premio no valor liquido de R$ 145.000,00\",\"ordem\":4},{\"codigoTipoSorteio\":\"girosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"20 PREMIOS DE R$ 1.000,00 (cada) - Valor liquido \",\"ordem\":5}],\"protocolo\":9278,\"titulos\":[258255],\"nome\":\"Simulador MsCap da Silva\",\"autenticacao\":\"9865fcbb8d8304d8d987700f9d19a5d1\",\"textoSucesso\":\"Titulo de Capitalizacao da Modalidade Filantropia Premiavel de Contribuicao Unica, emitido pela CAPEMISA Capitalizacao S.A,CNPJ 14.056.028/0001-55, aprovado pelo Processo SUSEP . CONTATO LOCAL: 67 3204-0356. SAC 0800 940 1130. OUVIDORIA 0800 707 4936, de segunda a sexta-feira, das 8h as 17h. E proibida a venda de titulo de capitalizacao a menores de dezesseis anos. O valor nao exigido dentro do prazo prescricional, estabelecido pela legislacao em vigor, acarretara a perda desse direito. A aquisicao deste titulo faculta ao adquirente a cessao de 100% do direito de resgate ao Hospital de Amor de Campo Grande, com o que concordo espontaneamente. Antes de contratar consulte previamente as Condicoes Gerais. As condicoes contratuais regulamento deste produto protocolizadas pela sociedade junto a SUSEP poderao ser consultadas no endereco eletronico www.susep.gov.br, de acordo com o numero de processo constante da proposta. Premios liquidos de imposto de renda. Confira o resultado dos sorteios e demais condicoes imprimindo seu titulo no App MS Cap ou acessando o site www.mscaperegiao.com.br. Autorizo que meus dados sejam utilizados para a finalidade de execucao de Promocoes na Plataforma APCAP. No mais, aceito livremente o tratamento conforme politica de privacidade de dados constante nos aplicativos da Plataforma APCAP.\",\"cupons\":[{\"codigo\":\"mscap\",\"numero\":258255,\"dezenas\":[\\\"04\",\"06\",\"12\",\"13\",\"15\",\"17\",\"19\",\"21\",\"24\",\"27\",\"33\",\"35\",\"36\",\"42\",\"43\",\"49\",\"51\",\"53\",\"54\",\"60\\\"]},{\"codigo\":\"mscap\",\"numero\":758255,\"dezenas\":[\\\"03\",\"04\",\"05\",\"08\",\"11\",\"17\",\"22\",\"26\",\"27\",\"29\",\"35\",\"37\",\"38\",\"42\",\"45\",\"47\",\"48\",\"51\",\"55\",\"56\\\"]}]},\"valorFormatado\":\"10,00\",\"telefoneFormatado\":\"(67) 99999-9999\",\"nomeFantasia\":\"Homologacao Plataforma WS recarga Multiproduto - NAO MEXER\",\"nomeFornecedor\":\"MS CAP\",\"cpf\":\"75554600174\",\"cepFormatado\":\"79063-640\",\"transacaoId\":\"aa4e28ce-4149-42c4-8e55-4dd80306d83b\"}",
      "idTransacao": "aa4e28ce-4149-42c4-8e55-4dd80306d83b",
      "dataHora": "2022-06-27T14:59:13.000-04:00"
    },
    "idExterno": "1026"
  }
}

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/mscap/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: 171

{"idTransacao":"aa4e28ce-4149-42c4-8e55-4dd80306d83b","estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","produto":"MS CAP","dataHoraCliente":"2022-06-27T13:09:40.244Z"}

{
   "idTransacao":"aa4e28ce-4149-42c4-8e55-4dd80306d83b",
   "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
   "produto":"MS CAP",
   "dataHoraCliente":"2022-06-27T13:09:40.244Z"
}

Exemplo de RESPONSE:

{
  "transacao": {
    "status": "EFETIVADA",
    "idTransacao": "aa4e28ce-4149-42c4-8e55-4dd80306d83b"
  }
}

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/mscap/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: 199

{"valor":"1000","estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4","idExterno":"1027","cep":"79083-461","cpf":"634.416.501-40","telefone":"67999999999","dataHoraCliente":"2022-06-27T13:09:40.244Z"}

{
   "valor":"1000",
   "estabelecimento":"81AA1C20B1688E4C7424C4E000334DD4",
   "idExterno":"1027",
   "cep":"79083-461",
   "cpf":"634.416.501-40",
   "telefone":"67999999999",
   "dataHoraCliente":"2022-06-27T13:09:40.244Z"
}

Exemplo de RESPONSE:

{
  "venda": {
    "estabelecimento": {
      "cnpjCpf": "75.862.116/0001-39",
      "nome": "Homologação Plataforma WS recarga Multiproduto - NÃO MEXER"
    },
    "produto": {
      "fornecedor": {
        "nome": "MS CAP"
      }
    },
    "transacao": {
      "valor": 1000,
      "status": "AUTORIZADA",
      "instrucao": "{\"estabelecimento\":\"1191874\",\"payload\":{\"idPromocao\":4188,\"dataSorteioPrincipal\":\"03/07/2022 09:00:00\",\"tituloPromocao\":\"3x10 MIL \\\\1 T-CROSS + 30 MIL \\\\20xMIL \",\"sorteios\":[{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"10 MIL REAIS - Valor liquido\",\"ordem\":1},{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"10 MIL REAIS - Valor liquido\",\"ordem\":2},{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"10 MIL REAIS - Valor liquido\",\"ordem\":3},{\"codigoTipoSorteio\":\"globosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"1 T-CROSS 0KM + 30 MIL REAIS - Sugestao de uso do premio no valor liquido de R$ 145.000,00\",\"ordem\":4},{\"codigoTipoSorteio\":\"girosorte\",\"dataSorteio\":\"03/07/2022 09:00\",\"descricao\":\"20 PREMIOS DE R$ 1.000,00 (cada) - Valor liquido \",\"ordem\":5}],\"protocolo\":9278,\"titulos\":[258255],\"nome\":\"Simulador MsCap da Silva\",\"autenticacao\":\"9865fcbb8d8304d8d987700f9d19a5d1\",\"textoSucesso\":\"Titulo de Capitalizacao da Modalidade Filantropia Premiavel de Contribuicao Unica, emitido pela CAPEMISA Capitalizacao S.A,CNPJ 14.056.028/0001-55, aprovado pelo Processo SUSEP . CONTATO LOCAL: 67 3204-0356. SAC 0800 940 1130. OUVIDORIA 0800 707 4936, de segunda a sexta-feira, das 8h as 17h. E proibida a venda de titulo de capitalizacao a menores de dezesseis anos. O valor nao exigido dentro do prazo prescricional, estabelecido pela legislacao em vigor, acarretara a perda desse direito. A aquisicao deste titulo faculta ao adquirente a cessao de 100% do direito de resgate ao Hospital de Amor de Campo Grande, com o que concordo espontaneamente. Antes de contratar consulte previamente as Condicoes Gerais. As condicoes contratuais regulamento deste produto protocolizadas pela sociedade junto a SUSEP poderao ser consultadas no endereco eletronico www.susep.gov.br, de acordo com o numero de processo constante da proposta. Premios liquidos de imposto de renda. Confira o resultado dos sorteios e demais condicoes imprimindo seu titulo no App MS Cap ou acessando o site www.mscaperegiao.com.br. Autorizo que meus dados sejam utilizados para a finalidade de execucao de Promocoes na Plataforma APCAP. No mais, aceito livremente o tratamento conforme politica de privacidade de dados constante nos aplicativos da Plataforma APCAP.\",\"cupons\":[{\"codigo\":\"mscap\",\"numero\":258255,\"dezenas\":[\\\"04\",\"06\",\"12\",\"13\",\"15\",\"17\",\"19\",\"21\",\"24\",\"27\",\"33\",\"35\",\"36\",\"42\",\"43\",\"49\",\"51\",\"53\",\"54\",\"60\\\"]},{\"codigo\":\"mscap\",\"numero\":758255,\"dezenas\":[\\\"03\",\"04\",\"05\",\"08\",\"11\",\"17\",\"22\",\"26\",\"27\",\"29\",\"35\",\"37\",\"38\",\"42\",\"45\",\"47\",\"48\",\"51\",\"55\",\"56\\\"]}]},\"valorFormatado\":\"10,00\",\"telefoneFormatado\":\"(67) 99999-9999\",\"nomeFantasia\":\"Homologacao Plataforma WS recarga Multiproduto - NAO MEXER\",\"nomeFornecedor\":\"MS CAP\",\"cpf\":\"63441650140\",\"cepFormatado\":\"79083-461\",\"transacaoId\":\"4a61e43c-58b6-4434-8ca9-cb8497df4647\"}",
      "idTransacao": "4a61e43c-58b6-4434-8ca9-cb8497df4647",
      "dataHora": "2022-06-27T15:02:03.000-04:00"
    },
    "idExterno": "1027"
  }
}

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/mscap/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

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

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

Exemplo de RESPONSE:

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