Consulta de limite de crédito

Este endpoint permite que o cliente do parceiro Bankly consulte o limite de crédito de seu cartão.

O limite de crédito é o valor máximo disponibilizado ao cliente para que ele possa realizar compras no período de um mês ou ao decorrer dos meses (parcelas).

📘

Nota

Este endpoint possui uma nova versão (2.0), que possibilita ao cliente do parceiro Bankly realizar não somente a consulta do limite de crédito, mas também o limite de saque (liberado, disponível e consumido) de seu cartão. Para mais detalhes sobre o endpoint Consulta de Limite de Crédito v2, basta selecionar a versão desejada no menu suspenso localizado no canto superior esquerdo da página.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que o cliente do parceiro Bankly:

• Tenha sido aprovado na análise de crédito;
• Tenha pelo menos um um cartão emitido.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}/limits \ 

--request GET \      
--url 'https://api-mtls.sandbox.bankly.com.br/cards/invoices/document/{documentNumber}/proxy/{proxy}/limits' \ 
--header 'Authorization:  Bearer {Token}'\ 
--header 'accept: application/json' \ 
--header 'api-version: 1.0' 

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.

Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição, envie os seguintes campos:

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso e retornará um objeto com os dados do limite de crédito do cartão.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{ 
  "totalCreditLimit": 0.0,
  "limitActive": 0.0,
  "availableLimit": 0.0 
} 

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.