Consulta de limite por feature

O endpoint a seguir retorna os limites estabelecidos para cada funcionalidade utilizada por nossos parceiros.

Etapas

Endpoint

Para utilizar o endpoint de consulta de limites por feature, é obrigatório o preenchimento dos seguintes campos no path da requisição:

documentNumber: número do documento do cliente (CPF/CNPJ), sem formatação;
limitType: nesse campo, informe CashIn ou CashOut para especificar o tipo de operação cujo limite será consultado;
featureName: informe a qual funcionalidade a consulta de limite se refere:
- Spi: para transferência via Pix;
- Spb: transferência via Ted;
- Withdrawn: saque/retirada de dinheiro;
- Card: compras com cartão pré-pago;
- PayBill: pagamento de conta.

--location  --request GET' https://api.sandbox.bankly.com.br/holders/{{documentNumber}}/limits/{{limitType}}/features/{{featureName}} ' \   
--header 'api-version: 1' \   
--header 'Authorization: Bearer ' \  
--header 'Content-Type: application/json' \

Retorno

A consulta retornará as seguintes informações:

cycle: ciclo referente à consulta (por transação, diário ou mensal);
level: indica se o limite está relacionado a cartão pré-pago, conta ou documento;
minAmount: 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: campo que exibe o limite global para as transações de uma feature;
amountToApply: 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: 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: 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: 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
   }
]