Criação e atualização de limite personalizado

stable

Este endpoint possibilita que o cliente de nosso parceiro solicite a criação de um limite para suas operações ou a atualização de um limite existente.

O cliente poderá diminuir seu limite de forma imediata. Porém, para aumentá-lo, precisará passar por uma análise prévia de prevenção e tesouraria.

🚧

Importante

Caso não haja sido cadastrado um limite personalizado para uma feature, ela utilizará o limite estabelecido para o parceiro como valor máximo para transações.

Requisição (Request)

Requisição HTTP

PUT https://api-mtls.sandbox.bankly.com.br/holders/{documentNumber}/max-limits 
--request PUT' \
--url https://api-mtls.sandbox.bankly.com.br/holders/{47742663023}/max-limits ' \   
--header 'api-version: 1.0' \    
--header 'Authorization: Bearer {token}' \  
--header 'Content-Type: application/json' \   
--data-raw ' { 
   "featureName": "SPI",  
   "cycleType": " Transaction", 
   "levelType": "Account", 
   "amount": 999.99 
    } '

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:

ScopeDescrição
limits.writeConcede acesso para atualizar o limite transacional de um cliente pessoa física ou jurídica.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

NomeTipoDescriçãoEspecificação
documentNumberpathObrigatório. Número do documento do cliente para o qual o limite será criado ou atualizado.Informe somente números.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescriçãoEspecificação
featureNamestringFuncionalidade à qual a consulta de limite se refere.
cycleTypestringCiclo de apuração dos limites, 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).
levelTypestringObrigatório. Nível em que o limite foi aplicado.Neste caso, o valor sempre será “Account”.
amountnumberObrigatório. Valor do limite escolhido pelo usuário.Decimal.

📘

Nota

Ao informar o valor no campo cicleType, lembre-se de que o limite transacional (Transaction) não pode ser maior que o diário (Daily) e que o limite diário não pode ser maior que o mensal (Monthly).

{     
  "featureName": "SPI",    
  "cycleType": "Transaction",     
  "levelType": "Account",     
  "amount": 999.99 
}

Resposta (Response)

O status code 201 indicará sucesso na criação ou atualização de limite personalizado.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescrição
documentNumberstringNúmero do documento do cliente
featureNamestringFuncionalidade à qual a consulta de limite se refere.
cycleTypestringCiclo de apuração dos limites, 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).
levelTypestringNível em que o limite foi aplicado.
amountnumberValor do limite escolhido pelo usuário.
{     
  "featureName": "SPI",    
  "cycleType": "Transaction",     
  "levelType": "Account",     
  "amount": 999.99 
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Funcionalidades

FuncionalidadeDescrição
SpiTransferência via Pix.
SpbTransferência via TED.
CardholderCompras com cartão pré-pago.
PayBillPagamento de conta.
WithdrawnSaques.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status codeCódigoDescrição
400BAD_REQUESTNão é possível cadastrar um limite para feature, cicle ou levelType não cadastrados.
400BAD_REQUESTNão é possível cadastrar um limite com valor maior que o do limite do ciclo.
400BAD_REQUESTNão é possível cadastrar um limite com valor menor que o do limite do ciclo.
400BAD_REQUESTNão é possível cadastrar um limite com campo amount menor ou igual a zero.
400BAD_REQUESTNão é possível cadastrar um limite com campo cycleType desconhecido.
400BAD_REQUESTNão é possível cadastrar um limite com campo LevelType desconhecido.
400BAD_REQUESTNão é possível cadastrar um limite com campo featureName vazio.
400BAD_REQUESTLimite não encontrado. Para atualizar um limite, é preciso que ele esteja cadastrado.

Eventos

Este endpoint não possui eventos relacionados a ele.


Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados