Consulta chave de contrato de plano

Consulta código do cartão de um credenciadocontrato de plano, que é uma chave, para obter o código do credenciadoplano contrato e o código dado mensalidade.plano. OA chave (número do cartãoo) é passado como parâmetro na URL do serviço.

Como consulta opcional, pode-se informar o CPF do credenciado como parâmetro QUERY STRING, desta forma, iremos validar se o CPFdocumento (CFP/CNPJ) informado pertence aoà códigochave do cartão informado.informada. Caso não pertença, iremos retornar cartãochave não encontrado.encontrada.

Em ambiente de desenvolvimento, todostodas cartões,chaves, com exceção daqueles iniciados pelo dígito “9”, serão encontrados e possuirão um credenciado_idplano_contrato_id e mensalidade_idplano_id gerado aleatoriamente. As requisições com cartõeschaves iniciadosiniciadas pelo dígito “9” retornarão código de erro 404 (not found).

GET api/integradores/cartoes/contratos_planos_chaves/<cartao_idchave>

HEADERS

CHAVE	VALOR	DESCRIÇÃO	OBRIGATÓRIO
Accept	application/vnd.linkc.com.br; version=1	Versão da API.	SIM
Authorization	Bearer <TOKEN>	Token obtido na autenticação	SIM
Content-Type	application/json	Tipo de conteúdo do request	SIM

PARÂMETRO QUERY STRING

CHAVE	DESCRIÇÃO	OBRIGATÓRIO
cpf	CPF do credenciado	NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE	DESCRIÇÃO
credenciado_idplano_contrato_id	Código do credenciado.contrato de plano.
cartao_id	Código do cartão.
mensalidade_idplano_id	Código dado mensalidade plano.

EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)

{
    "cartao"plano_contrato_chave": {
        "credenciado_id": "123456",
        "cartao_id"chave": "1234567890",
        "mensalidade_id"contrato_plano": {
          id: "",
          plano_id": "01"
        }
    }
}

OUTROS RETORNOS

CÓDIGO HTTP	DESCRIÇÃO
400	Caso não seja recebido o parâmetro <cartao_id>.
401	Caso as credenciais sejam inválidas.
422	Caso o cartão não seja encontrado.