Alterar valor máximo de autorização

Este endpoint permite ao usuário pagador editar o valor máximo de uma autorização de Pix automático.

Pré-requisito

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

O cliente de nosso parceiro tenha autorizado a recorrência de pagamentos via Pix automático que deseja ser alterada.

Requisição (Request)

Requisição HTTP

PUT https://api-mtls.sandbox.bankly.com.br/pix/automatic/authorization

curl --location --request PUT 'https://api-mtls.sandbox.bankly.com.br/pix/automatic/authorization' \
--header 'Authorization: Bearer' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'content-type: application/json' \
--header 'x-bkly-pix-user-id: 2345b6uwaiyr98cn12988' \
--header 'x-correlation-id: 3298cn190-w222n7-240jirY0239' \
--data '{
    "idRecurrence": "RR999999182026022455502218291",
    "amount": {
        "maximumValue": "100.25"
    }
}'

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
`pix.recurrence-payment-auth.write`	Concede acesso para editar o valor máximo de autorizações de pagamentos recorrentes via Pix automático.

Cabeçalhos (Headers)

Nome	Descrição	Especificação
`api-version`	Versão da API. Atualmente estamos na versão 1.	Valor padrão 1.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.	—
`x-bkly-pix-user-id`	Obrigatório. Número do documento do usuário que está fazendo a requisição.	Informe somente números.
`x-correlation-id`	Identificador de correlação da requisição.	Formato GUID v4. A cada requisição, deve-se gerar um novo GUID.

Parâmetros da rota (Path)

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

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`idRecurrence`	`string`	*Obrigatório*. Identificador único da recorrência autorizada.
`amount`	`objeto`	Objeto que deve conter os dados referentes ao valor do pagamento recorrente
`amount.maximumValue`	`string`	Valor máximo permitido para cada débito da recorrência quando a autorização usa valores variáveis. Pode ser limitado pelo valor mínimo definido pelo usuário recebedor. Não se aplica a autorizações de valor fixo. O Formato é uma string que representa um decimal com duas casas após a vírgula, ex: "100.25".

{
    "idRecurrence": "RR999999182026022455502218291",
    "amount": {
        "maximumValue": "100.25"
    }
}

Resposta (Response)

O status code 200 indicará que a requisição foi aceita e está sendo processada.

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

Erros

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

Status code	Código	Mensagem	Descrição
400	INVALID_PARAMETER		Algum parâmetro não foi informado corretamente.
403	AUTHORIZATION_REPROVED	Authorization request was not approved.	A solicitação de autorização do Pix Automático não pôde ser aprovada.
404			A notificação de recorrência não está vinculada ao CPF/CNPJ do usuário informado no x-bkly-pix-user-id e CompanyKey do token.
422	BUSINESS_RULE_VIOLATED	A mensagem a ser retornada está na tabela abaixo	Este erro pode retornar por vários motivos. Os motivos estarão descritos no campo "`messages`"
500	UNEXPECTED_ERROR	An unexpected result occurred during the operation	Ocorreu um erro inesperado.
500	PROCESSING_ERROR	Processing error.
503	SERVICE_UNAVAILABLE	Service unavailable.

`code`	`messages`
`BUSINESS_RULE_VIOLATED`	"status - Registro com status diferente de aceito"

Eventos

Este endpoint não possui eventos relacionados a ele.