Creating Checkout Cielo payment page

In integration via API, the payment page is created based on sent data that forms a shopping cart. This data is separated into the following main nodes:

After sending the cart data, Checkout will send a response containing a link to the payment page in the CheckoutUrl field.

📘

Important

The payment page creation request does not create a transaction. The returned URL (CheckoutUrl) is just a “pre-order” indicating that the payment page is ready to be used. The transaction is only created when the customer clicks Finalizar on the Checkout screen.

🚧

Warning

For your order number to be sent in the transaction to the statement for reconciliation purposes, follow the following formatting standards:

• Field: string;
• Minimum size: 1;
• Maximum size: 20;
• Allowed: letters (a-z, A-Z) and numbers (0-9);
• Not allowed: symbols and special characters, including white spaces;
• Do not repeat in less than 24 (twenty-four) hours.

❗️

Correios shipping service currently unavailable.

If a request with this shipping option is sent, you will receive a return with error 400 and the message: "The shipping service by post is unavailable." If you use the service on your payment links or checkout pages, change the shipping type to the other available options.

Creating a page with installment payments

Checkout Cielo allows merchants to process credit transactions in up to 18 installments.

Merchant can configure the number of installments per sale. Checkout calculates the installments considering the total amount and the installment limit sent via API.

⚠️

• Desired number of installments must be less than the amount registered in the Configurações da loja on the Cielo website;
• Checkout is limited to installments up to 18 times, even if your Cielo affiliation supports higher values. If the value presented in the Configurações da loja on the Cielo website is less than 18, contact Cielo Support and check the configuration of your Cielo affiliation.

Features

• Merchant sends the maximum number of installments they want to display to the shopper;
• Shipping cost is added to the installment amount.

Installment via API is done by sending the Payment.MaxNumberOfInstallments field. This will force Checkout to recalculate the installment amount. Example of the node:

{ 
  "Payment": {
  	"MaxNumberOfInstallments": 3
  },
}

Creating a payment page with discounts

Checkout Cielo allows the store to apply specific discounts both to the cart and to payment methods. The discounts available in Checkout Cielo are:

Note: You can apply discounts via API or Cielo website. If a discount value is sent in the API, this will be the value considered, even if the Cielo website has another registered value.

Applying discount to the cart

To send a discount on the cart, just send the Discount node within the Cart node:

{
    "Discount": {
      "Type": "Percent",
      "Value": "05"
    }
  }

Applying discount by payment method

To send a discount on boleto and/or credit card, send the corresponding field within the Payment node:

Boleto

Send the Payment.BoletoDiscount field:

Example

{
    "Payment": {
      "BoletoDiscount": "05"
    }
  }

Credit Card

Send the Payment.FirstInstallmentDiscount field:

Example

{
  "Payment": {
    "FirstInstallmentDiscount": 10
  }
}