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).

Pré-requisito

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

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:

Scope	Descrição
`invoice.read`	Concede acesso para realizar consultas referentes à gestão de faturas.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`authorization`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

Nome	Tipo	Descrição
`documentNumber`	`path`	Obrigatório. Número do documento do titular do cartão (CPF ou CNPJ).
`proxy`	`path`	Obrigatório. Identificador do cartão.

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:

Nome	Tipo	Descrição
`totalCreditLimit`	`number`	Total do limite de crédito aprovado.
`limitActive`	`number`	Limite habilitado pelo cliente.
`availableLimit`	`number`	Limite crédito disponível.

{ 
  "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.