Alterar status

Reativa, suspende ou cancela o contrato de um beneficiário.

Altera o status do contrato de um beneficiário. Use quando o cliente for suspenso, cancelado ou reativado no seu sistema.

POST /v1/TeleMedicina/AlteraStatus

POST https://api.sauddy.com.br/v1/TeleMedicina/AlteraStatus
Authorization: Bearer <token>
Content-Type: application/json

Corpo da requisição

CampoTipoObrigatórioDescrição
cpfstringSimCPF do beneficiário, com ou sem máscara.
numeroCartaostringSimNúmero do cartão retornado na adesão.
codigoOnixstringSimCódigo do plano do contrato.
novoStatusstringSimNovo status: "1" reativar, "2" suspender, "3" cancelar.

Valores de novoStatus

ValorAçãoEfeito
"1"ReativarO contrato volta a ficar Ativo.
"2"SuspenderO contrato fica Suspenso: o acesso é bloqueado temporariamente.
"3"CancelarO contrato fica Cancelado e a data de cancelamento é registrada.

Envie apenas 1, 2 ou 3:

Qualquer outro valor de novoStatus é tratado como reativação ("1"). Valide o valor no seu sistema antes de enviar.

Exemplos

curl -X POST https://api.sauddy.com.br/v1/TeleMedicina/AlteraStatus \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "cpf": "12345678909",
    "numeroCartao": "1234567890123456",
    "codigoOnix": "7426",
    "novoStatus": "3"
  }'

Resposta de sucesso — 200 OK

data contém o status aplicado.

{
  "data": "3",
  "errorMessage": "",
  "success": true
}

Regras de negócio

  • O contrato é localizado pela combinação CPF + numeroCartao + codigoOnix, apenas entre os contratos da sua empresa.
  • O cancelamento registra a data e a hora em que foi feito. Ela aparece em dataCancelamento na listagem de contratos por CPF.
  • Para reativar um contrato cancelado, envie novoStatus: "1" com os mesmos dados de identificação.
  • Homologação: nada é alterado. A API apenas devolve o novoStatus enviado.

Erros

HTTPQuando acontecemessage
400Campo obrigatório ausente, vazio ou não documentadoLista dos problemas, ex.: ["novoStatus should not be empty"]
400codigoOnix que não é um plano válido (também em homologação)codigoOnix inválido: "9999". Códigos aceitos: ...
401Token ausente, inválido ou expiradoToken não informado. ou Token inválido ou expirado.
404Nenhum contrato da sua empresa com esse CPF, cartão e planoContrato não encontrado.

Tempo de resposta:

Em produção, a alteração também é repassada à rede de telemedicina. Use um timeout de pelo menos 120 segundos nesta chamada.