Consulta valor da mensalidade
Consulta valor da mensalidade do credenciado, de acordo com os parâmetros do tipo de mensalidade e vencimento configurados na garagem.
Em ambiente de desenvolvimento, todos códigos de credenciados, com exceção daqueles iniciados pelo dígito “9”, serão encontrados e possuirão valor gerado aleatoriamente. As requisições com códigos de credenciados iniciados pelo dígito “9” retornarão código de erro 404 (not found).
GET api/integradores/credenciados/<credenciado_id>/pagamentos/new
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 |
RETORNO EM CASO DE SUCESSO (200 – OK)
CHAVE |
DESCRIÇÃO |
credenciado_id | Código do credenciado gerado na garagem. |
valor | Valor da mensalidade a ser pago. |
validade_datahora | Data e hora de validade da mensalidade. |
vencimento_datahora | Data e hora do próximo vencimento da mensalidade. |
EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)
{
"credenciado_pagamento": {
"credenciado_id": "123456",
"valor": 100.5,
"validade_datahora": "2021-08-20T23:59:59-03:00",
"vencimento_datahora": "2021-08-20T23:59:59-03:00"
}
}
OUTROS RETORNOS
CÓDIGO HTTP |
DESCRIÇÃO |
401 |
Caso as credenciais sejam inválidas. |
404 | Caso o código do credenciado não seja encontrado na garagem. |
502 | Caso não seja possível realizar comunicação com a automação da garagem. |