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
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cpf | string | Sim | CPF do beneficiário, com ou sem máscara. |
numeroCartao | string | Sim | Número do cartão retornado na adesão. |
codigoOnix | string | Sim | Código do plano do contrato. |
novoStatus | string | Sim | Novo status: "1" reativar, "2" suspender, "3" cancelar. |
Valores de novoStatus
| Valor | Ação | Efeito |
|---|---|---|
"1" | Reativar | O contrato volta a ficar Ativo. |
"2" | Suspender | O contrato fica Suspenso: o acesso é bloqueado temporariamente. |
"3" | Cancelar | O 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
dataCancelamentona 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
novoStatusenviado.
Erros
| HTTP | Quando acontece | message |
|---|---|---|
400 | Campo obrigatório ausente, vazio ou não documentado | Lista dos problemas, ex.: ["novoStatus should not be empty"] |
400 | codigoOnix que não é um plano válido (também em homologação) | codigoOnix inválido: "9999". Códigos aceitos: ... |
401 | Token ausente, inválido ou expirado | Token não informado. ou Token inválido ou expirado. |
404 | Nenhum contrato da sua empresa com esse CPF, cartão e plano | Contrato 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.