Atualização de dados da autorização

patch

https://api-staging.shipay.com.br/v1/automatic-pix/enrollment/{enrollment_id}

Esse serviço serviço deve ser utilizado para atualização de informações de uma autorização.

Observações:

Atualmente só é possível alterar o valor para recorrência de valor variável.
O prazo em que a atualização ficará vigente e será utilizada para criação das cobranças é informado no retorno deste serviço.

Path Params

enrollment_id

string

required

Identificador único da autorização.

Body Params

total_amount

number

Valor que será aplicado na criação das cobranças.

Calendar

object

Informações do calendário relacionadas a uma autorização (Enrollment), incluindo datas e frequência de pagamento.

retry_policy

string

enum

Define se o fluxo de retentativa para cobranças é permitido.
Caso este campo não seja enviado, por padrão a autorização é criada com o parâmetro configurado como "not_allowed"

Se a autorização for criada como 'not_allowed', não é possível realizar a alteração deste parâmetro posteriormente.

Valor	Descrição
`allowed`	Permite fluxo de retentativa. As retentativas serão agendadas em dias consecutivos.
`not_allowed`	Não permite fluxo de retentativa.
`allowed_alternate_days`	Permite fluxo de retentativa. As retentativas serão agendadas um dia após a tentativa anterior, em dias alternados.

Allowed:

Response

200Atualização realizada com sucesso.