Skip to main content

Consulta cartão de credenciado

Consulta código do cartão de um credenciado para obter o código do credenciado e o código da mensalidade. O número do cartão é 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 CPF informado pertence ao código do cartão informado. Caso não pertença, iremos retornar cartão não encontrado.

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

GET api/integradores/cartoes/<cartao_id>

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_id

Código do credenciado.

cartao_id

Código do cartão.

mensalidade_id

Código da mensalidade

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

{
    "cartao": {
        "credenciado_id": "123456",
        "cartao_id": "1234567890",
        "mensalidade_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.