Alterar valor máximo de autorização

stable

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 uma ou mais recorrências de pagamentos via Pix automático.

Requisição (Request)

Requisição HTTP

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

curl --request PUT \
     --url 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 '
{
  "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`	Obrigatório. Versão da API. Atualmente estamos na versão 1.	—
`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`	Obrigatório. 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 que pode ser debitado a cada pagamento efetivado sob a autorização correspondente. O valor máximo definido pelo usuário pagador pode ser limitado pelo valor mínimo definido a critério do usuário recebedor. Não se aplica para recorrências com valor fixo.

Resposta (Response)

O status code 202 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 não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated about 1 month ago