Criação e atualização de limite personalizado
stable
Caso seu cliente solicite a criação de um limite para suas operações ou a atualização de um limite existente, é possível fazê-lo por meio do endpoint a seguir.
Importante
O cliente final pode solicitar a alteração de limite para uma feature, cycle ou level desde que não ultrapasse o valor o valor máximo estabelecido para a feature.
Etapas
Endpoint
Para utilizar o endpoint de atualização de limite personalizado, é obrigatório o preenchimento dos seguintes campos:
documentNumber
: no path da requisição, informe o valor do documento do cliente para o qual o limite será criado ou atualizado;featureName
: no corpo da requisição, informe à qual funcionalidade a criação ou a atualização 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.
cycleType
: indique o ciclo de apuração dos limites:- Transaction: limite para uma única transação. O limite transacional não pode ser maior que o diário;
- Daily: o limite será referente a todas as transações feitas no dia;
- Monthly: considerará todas as transações feitas no mês.
levelType
: indique em que nível o limite que está sendo configurado será aplicado: card (para cartão pré-pago), account (conta) ou document (documento). Lembramos que, ao aplicar o limite a uma conta, ele irá se sobrepor ao limite do documento, que, por sua vez, se sobrepõe ao de um cartão;amount
: informe o valor do limite de transações.
--location --request PUT' https://api.sandbox.bankly.com.br/holders/{documentNumber}/max-limits ' \
--header 'api-version: 1' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw ' {
"featureName": "SPI",
"cycleType": " Transaction",
"levelType": "Account",
"amount": 999.99
} '
Retorno
O status code 200 indicará sucesso na criação ou atualização de limite personalizado.
{
"featureName": "SPI",
"cycleType": "Daily",
"levelType": "Account",
"amount": 5560
}
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.
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. |
Updated 12 months ago