Consultar limites da conta por feature

Este endpoint retorna os limites estabelecidos para cada funcionalidade utilizada por nossos parceiros.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O usuário esteja utilizando a Autenticação Gestão do Banco

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/Backoffice/limits

--request GET 'https://sandbox.hiperbanco.com.br/Backoffice/limits' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição	Especificação
`document`	`query`	Obrigatório. Número do documento do cliente (CPF ou CNPJ).	Informe somente números.
`featureName`	`query`	Obrigatório. Funcionalidade à qual a consulta de limite se refere.	__
`type`	`query`	Obrigatório. Nesse campo deve ser informado o valor “CashOut”, que é o tipo de operação que possibilita a consulta de limites.	__

Corpo da requisição (Body)

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

Funcionalidades (`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.

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, que pode ser `"Transaction"` (limite para uma única transação), `"Daily"` (limite 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, `"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`	Limite personalizado que será considerado nas transações. Esse campo retornará o valor de `maxAmount`, caso esse limite não esteja configurado.
`maxQuantity`	`number`	Quantidade máxima de vezes em que a feature pode ser utilizada em um ciclo. Por exemplo, um cliente poderá gerar até dez boletos no mês.
`usedAmount`	`number`	Quantidade do limite estabelecido que já foi utilizada. Para saber quanto ainda está disponível no período, subtraia esse valor de `amountToApply`.
`usedQuantity`	`number`	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
   }
]

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.