Create a payment link

post

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

ℹ️
Click EXAMPLES in the code box to see examples of link creation for:

digital products;

recurring;

physical asset with delivery.

Before sending the request, you must complete these steps:

Generate credentials (ClientID e o ClientSecret),
Generate the access_token using the credentials,
Send the generated access_token in the Authorization header of the request.

The token duration is 20 minutes.

ℹ️
Define Payment Methods
Use the customLinkConfiguration object to set the payment methods and digital wallets available for this link.

Payment methods and wallets not specified will not be displayed at checkout.

If the configuration is not sent, the link will follow the merchant's default settings.

Only payment methods contracted for the merchant will be shown to the shopper.

Body Params

OrderNumber

string

Store Order Number.
If not provided, the Link de pagamento will generate a number that will be visible to the customer.
Minimum size: 1.
Maximum size for reconciliation: 20.
Allowed characters: letters (a–z, A–Z) and numbers (0–9). Symbols and special characters are not allowed, including whitespace.
Do not repeat within 24 hours.
The field accepts up to 62 characters, but to ensure the order number flows through the entire transactional process to purpouses reconciliation, the functional maximum limit is 20 characters.

type

string

required

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

required

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.

showDescription

string

Flag indicating whether or not the description should be displayed on the payment screen.

price

int32

required

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.

softDescriptor

string

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

maxNumberOfInstallments

int32

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”.

quantity

string

Number of transactions remaining until the link stops working.

sku

string

Product identification code.

shipping

object

Shipping information.

recurrent

object

Recurrence information. Required for recurring transactions.

fixedinstallments

int32

Fixed and unique number of installments that the buyer can select on the payment screen, in case the store wishes to specify an exact number of installments that the cardholder can choose. Warning: do not send this field if the product type is ‘Recurrent’. Size: up to 2 characters (1 to 18 installments).

customLinkConfiguration

object

Allows you to define the payment methods and digital wallets that will be available to the shopper during checkout for this link.

Headers

Authorization

string

Defaults to Bearer {access_token}

Bearer {access_token}

Responses

Define Payment Methods

200200

201Created

400400