Atualizar um link de pagamentos

put

https://api-sandbox.asaas.com/v3/paymentLinks/{id}

Atualiza as configurações de um Link de Pagamento existente.

Use esta operação quando a configuração do link precisar ser alterada sem criar um novo Link de Pagamento.

Se a atualização fizer com que o link permita pagamento por boleto, informe dueDateLimitDays.

Quando chargeType for RECURRENT, informe subscriptionCycle para definir a periodicidade da assinatura. Para INSTALLMENT, utilize maxInstallmentCount para definir a quantidade máxima de parcelas disponível ao pagador.

Para adicionar ou alterar o redirecionamento após o pagamento, utilize callback.

Conteúdos relacionados

Guides

Path Params

string

required

Identificador único do seu link de pagamentos no Asaas

Body Params

name

string

Nome do link de pagamentos

description

string

Descrição do link de pagamentos

endDate

string

Data de encerramento

value

number

Valor do link de pagamentos, caso não informado o pagador poderá informar o quanto deseja pagar

active

boolean

Determina se o link de pagamentos está ativo

billingType

string

enum

Forma de pagamento permitida

Allowed:

chargeType

string

enum

Forma de cobrança

Allowed:

dueDateLimitDays

int32

Quantidade de dias úteis que o seu cliente poderá pagar após o boleto ser gerado (Para forma de pagamento como Boleto)

subscriptionCycle

string

enum

Periodicidade da cobrança, caso o chargeType seja RECURRENT

Allowed:

maxInstallmentCount

int32

Defaults to 1

Quantidade máxima de parcelas que seu cliente poderá parcelar o valor do link de pagamentos caso a forma de cobrança selecionado seja Parcelamento. Caso não informado o valor padrão será de 1 parcela

externalReference

string

Campo livre para busca

notificationEnabled

boolean

Defaults to true

Define se os clientes cadastrados pelo link de pagamentos terão as notificações habilitadas. Caso não seja informado o valor padrão será true

callback

object

Informações de redirecionamento automático após pagamento do link de pagamento

Responses

404

Not found

Conteúdos relacionados

Guides

200Ok

400Bad Request

401Unauthorized