Get cart installments information

The shopping cart is where the information on the products chosen by the customer while browsing a store is gathered. This data may include item prices, shipping value, payment, and delivery methods, among others.

This guide will describe how to obtain information about the number of installments and their respective amounts from an existing payment method in the shopping cart.

๐Ÿšง

Before starting the search for information about installments, make sure that there is already payment information (paymentData) assigned to the chosen cart (orderFormId).

Getting shopping cart information

The first step is to get the orderFormId of the shopping cart information that you want to obtain information about the amount of installments. For more information, access the Get cart information by ID guide.

Accessing cart installments information

With the orderFormId information available, you must use the Cart installments endpoint to send the following information through the URL:

  • Path Param: orderFormId value.
  • Query Param: paymentSystem. Payment method Id in which the installments information will be consulted.

See an URL example below:

https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/9420cbb7ebc34ca68a86621428816c5a?paymentSystem=2

After sending the request, the endpoint will return the response body containing the installments information, as shown in the example below:

...
{
      "paymentSystem": "2",
      "bin": null,
      "paymentName": null,
      "paymentGroupName": null,
      "value": 6940,
      "installments": [
          {
             "count": 1,
             "hasInterestRate": false,
             "interestRate": 0,
             "value": 6940,
             "total": 6940,
             "sellerMerchantInstallments": [
                  {
                     "id": "COSMETICS2",
                     "count": 1,
                     "hasInterestRate": false,
                     "interestRate": 0,
                     "value": 6940,
                     "total": 6940
                   }
              ]
          }
      ]
}
...

๐Ÿ“˜

For more information about the meaning of each of the fields available in the shopping cart, access the orderForm overview.

Error codes

The following errors may appear as a message in the response body.

400 - Bad Request

  • Message error example (code ORD002): "Invalid order form". The orderFormId information is not valid.
{
    "fields": {},
    "error": {
        "code": "ORD002",
        "message": "Invalid order form",
        "exception": null
    },
    "operationId": "d6a5b535-68b4-49f7-a783-93762974554b"
}
  • Message error example (code CHK0152): "Orderform does not have installment options". This shopping cart does not have any payment information (paymentData).
{
    "fields": {},
    "error": {
        "code": "CHK0152",
        "message": "Orderform does not have installment options",
        "exception": null
    },
    "operationId": "6d8408b4-3adf-4fc7-b708-8d322b3e021f"
}

404 - Not Found

  • Message error example: "The requested URL was not found on the server". Check that the URL data is correct.
<body>
    <h1>404 Not Found</h1>
    <p>The requested URL was not found on this server.</p>
</body>