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:
Scope | Descrição |
---|---|
limits.write | Concede acesso para atualizar 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 o seguinte campo:
Nome | Tipo | Descrição | Especificação |
---|---|---|---|
documentNumber | path | Obrigató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:
Nome | Tipo | Descrição | Especificação |
---|---|---|---|
featureName | string | Funcionalidade à qual a consulta de limite se refere. | — |
cycleType | string | Ciclo 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). | — |
levelType | string | Obrigatório. Nível em que o limite foi aplicado.Neste caso, o valor sempre será “Account”. | — |
amount | number | Obrigató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:
Nome | Tipo | Descrição |
---|---|---|
documentNumber | string | Número do documento do cliente |
featureName | string | Funcionalidade à qual a consulta de limite se refere. |
cycleType | string | Ciclo 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). |
levelType | string | Nível em que o limite foi aplicado. |
amount | number | Valor 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
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 pode retornar erros específicos, conforme a tabela a seguir:
Status code | Código | Descrição |
---|---|---|
400 | BAD_REQUEST | Não é possível cadastrar um limite para feature, cicle ou levelType não cadastrados. |
400 | BAD_REQUEST | Não é possível cadastrar um limite com valor maior que o do limite do ciclo. |
400 | BAD_REQUEST | Não é possível cadastrar um limite com valor menor que o do limite do ciclo. |
400 | BAD_REQUEST | Não é possível cadastrar um limite com campo amount menor ou igual a zero. |
400 | BAD_REQUEST | Não é possível cadastrar um limite com campo cycleType desconhecido. |
400 | BAD_REQUEST | Não é possível cadastrar um limite com campo LevelType desconhecido. |
400 | BAD_REQUEST | Não é possível cadastrar um limite com campo featureName vazio. |
400 | BAD_REQUEST | Limite não encontrado. Para atualizar um limite, é preciso que ele esteja cadastrado. |
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago