{"swagger":"2.0","info":{"description":"[Cliente] Respons\u00e1vel pelo gerenciamento de cart\u00f5es","version":"1.0.0","title":"API v1 Cart\u00f5es","termsOfService":"Shareware","contact":{"name":"Unimed Fesp"},"license":{"name":"UNIMED FESP V1.18.0.0","url":"https:\/\/unimedfesp.coop.br"}},"host":"api-unimedsp.sensedia.com","basePath":"\/sandboxis\/api\/v1\/cartoes","schemes":["https"],"paths":{"\/bloquear":{"post":{"summary":"Permitir a aplica\u00e7\u00e3o de backend enviar dados para o bloqueio do cart\u00e3o de um benefici\u00e1rio na singular.","description":"Permitir a aplica\u00e7\u00e3o de backend enviar dados para o bloqueio do cart\u00e3o de um benefici\u00e1rio na singular.","parameters":[],"responses":{"200":{"description":"OK"}}}},"\/segundaVia\/{cartaoBeneficiario}":{"get":{"summary":"Retorna solicita\u00e7\u00f5es de segunda via de cart\u00f5es titular e dos dependentes","description":"Retorna solicita\u00e7\u00f5es de segunda via de cart\u00f5es titular e dos dependentes","operationId":"GetSolicitacoesSegundaVia","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"cartaoBeneficiario","in":"path","description":"Numero Cart\u00e3o","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.CartaoSegundaVia"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/segundaVia":{"post":{"summary":"Envia solicita\u00e7\u00e3o de segunda via de cart\u00e3o de um benefici\u00e1rio","description":"Envia solicita\u00e7\u00e3o de segunda via de cart\u00e3o de um benefici\u00e1rio","operationId":"PostSegundaVia","consumes":["application\/json-patch+json","application\/json","text\/json","application\/*+json"],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"in":"body","name":"cartaoSegundaVia","required":false,"schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.SegundaVia"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/cpf\/{cpf}":{"get":{"summary":"Busca cart\u00f5es ativos de um benefici\u00e1rio na singular","description":"Busca cart\u00f5es ativos de um benefici\u00e1rio na singular","operationId":"GetCpf","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"cpf","in":"path","description":"CPF do benefici\u00e1rio","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.Cartao"},"uniqueItems":false}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/beneficiario\/{cartaoBeneficiario}":{"get":{"summary":"Busca informa\u00e7\u00f5es do cart\u00e3o de um benefici\u00e1rio na singular","description":"Busca informa\u00e7\u00f5es do cart\u00e3o de um benefici\u00e1rio na singular","operationId":"GetCartao","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"cartaoBeneficiario","in":"path","description":"Cart\u00e3o do benefici\u00e1rio","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.Cartao"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/bloqueados\/{cartaoBeneficiario}\/enderecos":{"get":{"summary":"Retorna endere\u00e7os e dados cadastrais do benefici\u00e1rio para desbloqueio","description":"Retorna endere\u00e7os e dados cadastrais do benefici\u00e1rio para desbloqueio","operationId":"GetEnderecosBeneficiario","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"cartaoBeneficiario","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.CartaoBeneficiarioEndereco"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/desbloquear":{"post":{"summary":"Permitir a aplica\u00e7\u00e3o de backend enviar dados para o desbloqueio do cart\u00e3o de um benefici\u00e1rio na singular.","description":"Permitir a aplica\u00e7\u00e3o de backend enviar dados para o desbloqueio do cart\u00e3o de um benefici\u00e1rio na singular.","parameters":[],"responses":{"200":{"description":"OK"}}}},"\/beneficiario\/{cartaoBeneficiario}\/validade\/{dataValidade}":{"get":{"summary":"Verifica se existe algum cart\u00e3o do benefici\u00e1rio com a validade informada independente da situa\u00e7\u00e3o ou via do cart\u00e3o","description":"Verifica se existe algum cart\u00e3o do benefici\u00e1rio com a validade informada independente da situa\u00e7\u00e3o ou via do cart\u00e3o","operationId":"GetCartaoBeneficiarioValidade","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"cartaoBeneficiario","in":"path","description":"Cart\u00e3o do benefici\u00e1rio","required":true,"type":"string"},{"name":"dataValidade","in":"path","description":"Data de validade","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.CartaoValidade"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/segundaVia\/tratarDevolucao":{"post":{"summary":"Envia os dados necess\u00e1rios para tratar um solicita\u00e7\u00e3o de cart\u00e3o devolvido","description":"Envia os dados necess\u00e1rios para tratar um solicita\u00e7\u00e3o de cart\u00e3o devolvido","operationId":"PostDevolucao","consumes":["application\/json-patch+json","application\/json","text\/json","application\/*+json"],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"in":"body","name":"cartaoSegundaVia","required":false,"schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.CartaoSegundaViaTratarSolicitacao"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/familia\/{cartaoBeneficiario}":{"get":{"summary":"Busca cart\u00f5es de uma fam\u00edlia na singular para gera\u00e7\u00e3o dos cart\u00f5es virtuais no aplicativo.","description":"Busca cart\u00f5es de uma fam\u00edlia na singular para gera\u00e7\u00e3o dos cart\u00f5es virtuais no aplicativo.","operationId":"GetCartaoFamilia","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"cartaoBeneficiario","in":"path","description":"Cart\u00e3o do benefici\u00e1rio","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.Cartao"},"uniqueItems":false}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/desbloqueio":{"post":{"summary":"Envia dados para o desbloqueio do cart\u00e3o de um benefici\u00e1rio na singular","description":"Envia dados para o desbloqueio do cart\u00e3o de um benefici\u00e1rio na singular","operationId":"PostDesbloqueio","consumes":["application\/json-patch+json","application\/json","text\/json","application\/*+json"],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"in":"body","name":"cartaoBeneficiario","required":false,"schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.CartaoBeneficiarioEndereco"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]},"\/bloqueados\/{cartaoBeneficiario}":{"get":{"summary":"Retorna cart\u00f3es bloqueados de uma fam\u00edlia na singular, para desbloqueio pelo aplicativo","description":"Retorna cart\u00f3es bloqueados de uma fam\u00edlia na singular, para desbloqueio pelo aplicativo","operationId":"GetCartoesBloqueados","consumes":[],"produces":["application\/json"],"parameters":[{"$ref":"#\/parameters\/client_id"},{"$ref":"#\/parameters\/authorization"},{"name":"cartaoBeneficiario","in":"path","description":"Cart\u00e3o do benefici\u00e1rio","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.CartaoBloqueadoFamilia"}},"204":{"description":"Success"},"400":{"description":"Bad Request","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}},"500":{"description":"Server Error","schema":{"$ref":"#\/definitions\/Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError"}}}},"parameters":[]}},"definitions":{"Univision.Fesp.API.Application.Filters.HttpGlobalExceptionFilter.JsonError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"remoteAddress":{"type":"string"},"path":{"type":"string"},"developerMessage":{"type":"object","properties":[]}}},"Univision.Fesp.API.Model.Cartoes.Cartao":{"type":"object","properties":{"unimed":{"type":"string","description":"C\u00f3digo Unimed"},"contrato":{"type":"string","description":"C\u00f3digo do Contrato na Operadora"},"familia":{"type":"integer","format":"int32","description":"Fam\u00edlia"},"numero":{"type":"string","description":"Num\u00e9rico do Cart\u00e3o"},"plano":{"type":"string","description":"Nome do Produto"},"nascimento":{"type":"string","description":"Data de nascimento"},"titular":{"type":"boolean","description":"Indicativo de Titularidade"},"contratacao":{"type":"integer","format":"int32","description":"Tipo de contrata\u00e7\u00e3o"},"acomodacao":{"type":"string","description":"Acomoda\u00e7\u00e3o"},"validade":{"type":"string","description":"Data de Validade"},"nome":{"type":"string","description":"Nome do Benefici\u00e1rio"},"rede":{"type":"string","description":"C\u00f3digo da Rede Referenciada"},"local":{"type":"string","description":"C\u00f3digo da Unimed de Atendimento do Benefici\u00e1rio"},"dependencia":{"type":"string","description":"C\u00f3digo da Depend\u00eancia do Benefici\u00e1rio"},"regulamentado":{"type":"integer","format":"int32","description":"Indicador do Registro do Plano"},"segmentacao":{"type":"integer","format":"int32","description":"Segmenta\u00e7\u00e3o Assistencial do Plano"},"abrangencia":{"type":"integer","format":"int32","description":"Abrang\u00eancia"},"via":{"type":"integer","format":"int32","description":"Via do Cart\u00e3o"},"cpt":{"type":"string","description":"Nome da Contratante"},"cns":{"type":"string"},"contratante":{"type":"string"},"codProdutoANS":{"type":"string","description":"C\u00f3digo do produto na ANS"},"areaAtuacao":{"type":"string","description":"\u00c1rea de Atua\u00e7\u00e3o"},"obs":{"type":"string","description":"Observa\u00e7\u00f5es"},"sexo":{"type":"string","description":"Sexo do Benefici\u00e1rio"},"tipoContratante":{"type":"integer","format":"int32","description":"Tipo de Contratante"},"nomeSocial":{"type":"string","description":"Nome social do benefici\u00e1rio"},"unimedContratada":{"type":"string","description":"Unimed Contratada"},"vigencia":{"type":"string","description":"Data in\u00edcio do contrato"},"carencias":{"type":"array","description":"Lista de car\u00eancias","items":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.Carencia"}},"cooperado":{"type":"boolean","description":"Indica se beneficiario tamb\u00e9m \u00e9 cooperado (para exibir o cart\u00e3o com as cores de m\u00e9dico cooperado)\r\nRN: Se o benefici\u00e1rio for identificado como um cooperado, dever\u00e1 ser informado atrav\u00e9s deste campo para que o seu cart\u00e3o virtual seja exibido nas cores determinadas pelo PTU."},"tipoRede":{"type":"integer","format":"int32","description":"RN: Juntamente com a Rede de Atendimento, h\u00e1 a obrigat\u00f3riedade de informar o tipo do prestador.A univision implementou este campo novo para que seja informado conforme o enum declarado na tipifica\u00e7\u00e3o."},"cidades":{"type":"array","description":"Codigo IBGE das cidades da area de abrangencia","items":{"type":"string"}}},"description":"Representa\u00e7\u00e3o da entidade de cart\u00e3o"},"Univision.Fesp.API.Model.Cartoes.Carencia":{"type":"object","properties":{"cobertura":{"type":"string","description":"Tipo de Cobertura"},"dataCarencia":{"type":"string","description":"Data final de car\u00eancia"}},"description":"Representa\u00e7\u00e3o da entidade de Car\u00eancia"},"Univision.Fesp.API.Model.Cartoes.CartaoValidade":{"type":"object","properties":{"existeCartao":{"type":"boolean","description":"Indicativo de cart\u00e3o v\u00e1lido"}},"description":"Representa\u00e7\u00e3o da entidade de valida\u00e7\u00e3o do cart\u00e3o"},"Univision.Fesp.API.Model.Cartoes.CartaoSegundaVia":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Identificador da solicita\u00e7\u00e3o no sistema de Gest\u00e3o"},"beneficiarioCartao":{"type":"string","description":"C\u00f3digo de Indentifica\u00e7\u00e3o do Benefici\u00e1rio.\r\nIncluindo o d\u00edgito verficador e o c\u00f3digo da Unimed"},"solicitanteCartao":{"type":"string","description":"C\u00f3digo de Identifica\u00e7\u00e3o do Benefici\u00e1rio que solicitou a Segunda Via"},"protocolo":{"type":"string","description":"Protocolo de atendimento da solicita\u00e7\u00e3o de cart\u00e3o"},"situacao":{"type":"integer","format":"int32","description":"Situa\u00e7\u00e3o de Solicita\u00e7\u00e3o\r\n0 = Pendente\r\n1 = Conclu\u00eddo\r\n2 = Devolvido"},"prazoEntrega":{"type":"integer","format":"int32","description":"Prazo de entrega em dias da solicita\u00e7\u00e3o"},"motivo":{"type":"string","description":"Motivo da solicita\u00e7\u00e3o"},"formaEntrega":{"type":"integer","format":"int32","description":"C\u00f3digo do Tipo de Forma de entrega\r\n1 = Correios\r\n2 = Unidade de Atendimento"},"valor":{"type":"number","format":"double","description":"Valor em reais da Solicita\u00e7\u00e3o de Cart\u00e3o"},"endereco":{"description":"Endere\u00e7o de correspond\u00eancia","$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.DadosEndereco"},"unidade":{"type":"string","description":"Refer\u00eancia do Sistema de Gest\u00e3o da Unidade de Atendimento"},"dataInclusao":{"type":"string","description":"Data e hora da inclus\u00e3o da solicita\u00e7\u00e3o"},"dataAlteracao":{"type":"string","description":"Data e hora de altera\u00e7\u00e3o da solicita\u00e7\u00e3o"},"dataConclusao":{"type":"string","description":"Data e hora da conclus\u00e3o da solicita\u00e7\u00e3o"}},"description":"Representa\u00e7\u00e3o da entidade Cart\u00e3o Segunda Via"},"Univision.Fesp.API.Model.Cartoes.DadosEndereco":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Identificador do endere\u00e7o no sitema de gest\u00e3o"},"cep":{"type":"string","description":"CEP"},"tipoEndereco":{"type":"integer","format":"int32","description":"Tipo de Endere\u00e7o\r\n1 = residencial\r\n2 = correspond\u00eancia"},"endereco":{"type":"string","description":"Endere\u00e7o"},"numero":{"type":"integer","format":"int32","description":"N\u00famero"},"bairro":{"type":"string","description":"Bairro"},"complemento":{"type":"string","description":"Complemento"},"municipio":{"type":"string","description":"Munic\u00edpio"},"estado":{"type":"string","description":"Estado"},"codigoIbge":{"type":"integer","format":"int32","description":"C\u00f3digo IBGE"},"telefone":{"type":"string","description":"Telefone"}}},"Univision.Fesp.API.Model.Cartoes.CartaoBloqueadoFamilia":{"type":"object","properties":{"numero":{"type":"string","description":"Num\u00e9rico do Cart\u00e3o"},"dependencia":{"type":"string","description":"C\u00f3digo da Depend\u00eancia do Benefici\u00e1ri"},"validade":{"type":"string","description":"Validade"},"nome":{"type":"string","description":"Nome do Benefici\u00e1rio"}}},"Univision.Fesp.API.Model.Cartoes.CartaoBeneficiarioEndereco":{"type":"object","properties":{"nome":{"type":"string"},"numero":{"type":"string"},"dependencia":{"type":"string"},"bloqueado":{"type":"boolean"},"nomeMae":{"type":"string"},"cpf":{"type":"string"},"email":{"type":"string"},"pis":{"type":"string"},"celular":{"type":"string"},"enderecos":{"type":"array","items":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.DadosEndereco"}}}},"Univision.Fesp.API.Model.Cartoes.CartaoSegundaViaTratarSolicitacao":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Identificador da solicita\u00e7\u00e3o no sistema de Gest\u00e3o"},"unidade":{"type":"string","description":"Refer\u00eancia do Sistema de Gest\u00e3o da Unidade de Atendimento"},"protocolo":{"type":"string","description":"Protocolo de atendimento da solicita\u00e7\u00e3o de cart\u00e3o"},"beneficiarioCartao":{"type":"string","description":"C\u00f3digo de Indentifica\u00e7\u00e3o do Benefici\u00e1rio.\r\nIncluindo o d\u00edgito verficador e o c\u00f3digo da Unimed"},"solicitanteCartao":{"type":"string","description":"C\u00f3digo de Identifica\u00e7\u00e3o do Benefici\u00e1rio que solicitou a Segunda Via"},"prazoEntrega":{"type":"integer","format":"int32","description":"Prazo de entrega em dias da solicita\u00e7\u00e3o"}},"description":"Representa\u00e7\u00e3o da entidade Cart\u00e3o Segunda Via tratar solicita\u00e7\u00e3o"},"Univision.Fesp.API.Model.Cartoes.SegundaVia":{"type":"object","properties":{"beneficiarioCartao":{"type":"string","description":"Cart\u00e3o do benefici\u00e1rio"},"solicitanteCartao":{"type":"string","description":"Solicitante do cart\u00e3o"},"motivoSolicitacao":{"type":"string","description":"Motivo da Solicita\u00e7\u00e3o"},"formaEntrega":{"type":"integer","format":"int32","description":"Forma de entrega do cart\u00e3o"},"valor":{"type":"number","format":"double","description":"Valor da entrega"},"prazoEntrega":{"type":"integer","format":"int32","description":"Prazo da entrega"},"unidade":{"type":"integer","format":"int32","description":"Unidade de Atendimento"},"enderecos":{"type":"array","description":"Endere\u00e7o de entrega","items":{"$ref":"#\/definitions\/Univision.Fesp.API.Model.Cartoes.DadosEndereco"}}},"description":"Representa\u00e7\u00e3o da entidade de Car\u00eancia"}},"parameters":{"client_id":{"name":"client_id","in":"header","description":"Token de identifica\u00e7\u00e3o do app","required":true,"type":"string"},"authorization":{"name":"authorization","in":"header","description":"Credenciais para autenticar o agente de usu\u00e1rio com o servidor","required":true,"type":"string"}},"x-servers":{"4":"https:\/\/api-unimedsp.sensedia.com\/sandboxis\/"}}