Update a payment link

put

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

Updates an existing link by providing the link's id.

ℹ️
Learn more about this feature in the documentation.

You can update a link to change the payment method, add a new item to the order, modify the order description, or change the recurrence type, for example.

Send only the fields that need to be updated.

ℹ️
To convert a link transaction into a recurring transaction, update the link by sending the fields Interval (required) and EndDate (optional) as indicated in Update recurrent payment

Path Params

string

required

Defaults to 123abc34-5678-9012-3d4e-5f6g7h8i9j0

Payment link id value.

Body Params

type

string

Type of sale to be carried out through the payment link:
Asset – Physical Material
Digital – Digital Product
Service – Service
Payment – Simple Payments
Recurrent – Recurrent Payment

name

string

Product name

description

string

Product description that will be displayed on the payment screen if the show_description option is true. It is allowed to use the pipe character | if you want to break the line when presenting the description on the payment screen.

price

int32

Product value in cents.

expirationDate

date

Link expiration date. If a date is informed, the link becomes unavailable on the informed date. If no date is informed, the link does not expire. The property also allows you to include an expiration time, but it is not required. If a time is not included, the default is 00:00:00.

weight

string

Product weight in grams.

sku

string

Product identification code.

shipping

object

Shipping information

SoftDescriptor

string

Description to be presented on the cardholder's credit card statement.

maxNumberOfInstallments

string

Maximum number of installments that the shopper can select on the payment screen. If not informed, the store settings will be used. Warning: do not send this field if the product type (type) is equal to “Recurrent”.

Headers

Authorization

string

Defaults to Bearer {access_token}

Responses

200200

400400