Alteração de limite ativo de cartão pós-pago
stable
Este endpoint possibilita que o cliente do parceiro Bankly altere o limite de crédito ativo do seu cartão pós-pago.
Nota
Limite de crédito ativo é aquele determinado pelo cliente dentro da faixa de limite pré-estabelecida pelo parceiro após a análise de crédito.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente do parceiro possua um cartão pós-pago com limite de crédito aprovado;
Requisição
Requisição HTTP
PATCH 'https://api-mtls.sandbox.bankly.com.br/cards/limit'
--request PATCH \
--url https://api-mtls.sandbox.bankly.com.br/cards/limit \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer {token}' \
--data-raw '
{
"documentNumber": "47742663023",
"contractNumber": "000124",
"limit": 200
}'
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 |
---|---|
card.update | Concede acesso para atualizar o limite de crédito de uma cartão. |
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)
Não é necessário enviar parâmetros no path desta requisição.
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
Nome | Tipo | Descrição | Especificação |
---|---|---|---|
documentNumber | string | Obrigatório. Número de documento de CPF ou CNPJ. | Informe somente os números. Exemplo: “00000000000”. |
contractNumber | string | Obrigatório. Número do contrato do cliente. | --- |
limit | number | Obrigatório. Novo limite de crédito ativo (definido pelo cliente). | --- |
{
"documentNumber": "47742663023",
"contractNumber": "467343786316847",
"limit": 750.50
}
Resposta (Response)
O status code 204 indicará que a solicitação foi aceita com sucesso e que o limite foi alterado.
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint pode retornar um erro específico, conforme a tabela a seguir:
Status code | Código | Descrição |
---|---|---|
400 | LIMIT_REQUESTED_INVALID | Limite solicitado maior que o disponível. |
Além disso, este endpoint também poderá retornar [erros comuns (https://docs.bankly.com.br/docs/erros) entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated about 1 month ago