Atualizar link de pagamento

put

https://cieloecommerce.cielo.com.br/api/public/v1/products/{id}

Atualiza um link existente ao informar o id do link.

ℹ️
Saiba mais sobre essa funcionalidade na documentação.

Você pode atualizar um link para alterar informações do produto, formas de pagamento, carteiras digitais ou configurações de recorrência.

Envie apenas os campos que necessitam atualização.

ℹ️
Para transformar a transação de um link em uma transação recorrente, atualize o link enviando os campos Interval (obrigatório) e EndDate (opcional) indicados em Atualizar recorrência.

Path Params

string

required

Valor do id do link de pagamento.

Body Params

type

string

Tipo de venda do link de pagamento:
Asset – Material Físico
Digital – Produto Digital
Service – Serviço
Payment – Pagamentos Simples
Recurrent – Pagamento Recorrente.
Tamanho: 255.

name

string

Nome do produto. Tamanho: 128.

description

string

Descrição do produto que será exibida na tela de pagamento caso a opção show_description seja verdadeira. É permitido usar o caracter pipe | caso seja desejável quebrar a linha ao apresentar a descrição na tela de pagamento.

price

int32

Preço do produto. Tamanho: 1000000.

expirationDate

date

Data de expiração do link. Caso uma data seja informada, o link se torna indisponível na data informada. Se nenhuma data for informada, o link não expira. O campo permite incluir um horário de expiração, mas não é obrigatório. Se um horário não for incluso, o padrão considerado é 00:00:00. Tamanho: 10.

weight

string

Peso do produto em gramas. Tamanho: 2000000.

sku

string

Código de identificação do produto. Tamanho: 32.

shipping

object

Informações de frete.

SoftDescriptor

string

Descrição a ser apresentada na fatura do cartão de crédito do portador. Tamanho: 13.

maxNumberOfInstallments

int32

Número máximo de parcelas que o comprador pode selecionar na tela de pagamento. Se não informado, será utilizada as configurações da loja. Atenção: não envie esse campo se o tipo de produto (type) for igual a “Recurrent”. até 2 caracteres (1 a 18 parcelas)

customLinkConfiguration

object

Permite definir os meios de pagamento e carteiras digitais que ficarão disponíveis para o comprador durante o checkout desse link.

Headers

Authorization

string

required

Bearer {access_token}

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400

404404