VTEX Developer Portal

Using Checkout API to set a discount

One of the most used customer attraction strategies in ecommerce is applying a discount to the cash price when choosing a specific payment method. Commonly, the discount price is visible only at the checkout payment stage after the user has already chosen the payment method that grants the discount.

This Checkout configuration sets the discount price and links it to a payment method. To configure, follow the steps below:

  1. Contact our Support to enter the desired payment method ID in the paymentSystemToCheckFirstInstallment property.

  2. To get the payment method ID, access Settings in the Payments module. The ID of the condition you want to use is on the right side of the screen in the Payments Settings > Payments Conditions section.

  1. After updating paymentSystemToCheckFirstInstallment, you can run the Do OrderForm Simulation endpoint. Thus, you will be able to verify that the chosen payment method has been updated with the discount in the cash payment option in the installmentOptions section, within paymentData.
"paymentData":{
    "installmentOptions":[
     {
         "paymentSystem":"6",
         "paymentName":"Boleto Bancário",
         "paymentGroupName":"bankInvoicePaymentGroup",
         "value":10000,
         "installments":[
             {
                 "count":1,
                 "hasInterestRate":false,
                 "interestRate":0,
                 "value":9000,
                 "total":9000,
             }
         ]
     }
    ]
}

Updated about a month ago



Using Checkout API to set a discount


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.