Consulta de limite por feature
stable
Este endpoint retorna os limites estabelecidos para cada funcionalidade utilizada por nossos parceiros.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/holders/{{documentNumber}}/limits/{{limitType}}/features/{{featureName}}
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/holders/{{documentNumber}}/limits/{{limitType}}/features/{{featureName}} ' \
--header 'api-version: 1.0' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
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 |
|---|---|
limits.read | Concede acesso para consultar o limite transacional de um cliente pessoa física ou jurídica. |
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 | Especificação |
|---|---|---|---|
documentNumber | string | Obrigatório. Número do documento do cliente. | Informe somente números. |
limitType | string | Obrigatório. Nesse campo deve ser informado o valor “CashOut”, que é o tipo de operação que possibilita a consulta de limites. | — |
featureName | string | Obrigatório. Funcionalidade à qual a consulta de limite se refere. | — |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará sucesso na consulta .
Sendo bem-sucedido, o retorno irá trazer uma lista com os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
cycle | string | Ciclo referente à consulta, o qual pode ser: Transaction (limite para uma única transação), Daily (o limite será referente a todas as transações feitas no dia) ou Monthly (considerará todas as transações feitas no mês). |
level | string | Nível em que o limite foi aplicado. Neste caso, o valor sempre será “Account”. |
minAmount | number | Valor mínimo para as transações de uma feature. Por exemplo, um boleto só pode ser gerado com valor mínimo de R$ 10,00. |
maxAmount | number | Campo que exibe o limite global para as transações de uma feature. |
amountToApply | number | Informa o limite personalizado que será considerado nas transações. Esse campo retornará o valor do maxAmount, caso esse limite não esteja configurado. |
maxQuantity | number | Indica a quantidade máxima de vezes em que a feature pode ser utilizada num ciclo. Por exemplo, um cliente poderá gerar até dez boletos no mês. |
usedAmount | number | Informa quanto do limite estabelecido já foi utilizado. Para que o parceiro saiba quanto ainda está disponível no período, ele deve subtrair esse valor do amountToApply. |
usedQuantity | number | Indica a quantidade de vezes que a feature já foi utilizada. |
[
{
"cycle": "Transaction",
"level": "Account",
"minAmount": 0,
"maxAmount": 999.99,
"amountToApply": 999.99,
"maxQuantity": 1,
"usedAmount": 999.99,
"usedQuantity": 0
},
{
"cycle": "Daily",
"level": "Account",
"minAmount": 0,
"maxAmount": 999.99,
"amountToApply": 999.99,
"maxQuantity": 0,
"usedAmount": 0,
"usedQuantity": 0
},
{
"cycle": "Monthly",
"level": "Account",
"minAmount": 0,
"maxAmount": 999.99,
"amountToApply": 999.99,
"maxQuantity": 0,
"usedAmount": 0,
"usedQuantity": 0
}
]
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Funcionalidades (featureName)
featureName)| Funcionalidade | Descrição |
|---|---|
| SPI | Transferência via Pix. |
| SPB | Transferência via TED. |
| Cardholder | Compras com cartão pré-pago. |
| PayBill | Pagamento de conta. |
| Withdrawn | Saques. |
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.
Updated about 1 month ago