Consulta de limite de crédito
stable
Este endpoint permite que o cliente do parceiro Bankly consulte o limite de crédito e de saque 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é-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
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: 2.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 2.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 e de saque do cartão.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
invoice | object | Objeto que contém informações sobre o limite de crédito do cliente. |
invoice.totalCreditLimit | number | Total do limite de crédito aprovado. |
invoice.limitActive | number | Limite habilitado pelo cliente. |
invoice.availableLimit | number | Limite crédito disponível. |
withdrawal | object | Objeto que contém informações sobre o limite de saque do cliente. |
withdrawal.totalLimit | number | Limite concedido de saque. |
withdrawal.availableLimit | number | Limite disponível de saque. |
withdrawal.spentLimit | number | Limite de saque utilizado. |
{
invoice: {
totalCreditLimit: 0.0,
availableLimit: 0.0,
limitActive: 0.0
},
withdrawal: {
totalLimit: 0.0,
availableLimit: 0.0,
spentLimit: 0.0
}
}
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | CARD_NOT_BELONG_DOCUMENT_NUMBER | Card does not belong to this document number! | O cartão informado não pertence a este documento. |
| 400 | CARD_TYPE_INVALID | Card type is invalid | Tipo de cartão inválido. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated 2 months ago