---
title: "Get installments options"
method: GET
path: "/api/pvt/installments"
tags: ["Installments"]
---

# Get installments options

`GET /api/pvt/installments`

Returns the best installment options according to the parameters informed in the request.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| PCI Gateway | Payment-Make Payments | **View Payment Data** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Query parameters

- `request.value` integer, required
- `request.salesChannel` integer
- `request.paymentDetails[0].id` integer
- `request.paymentDetails[0].value` integer
- `request.paymentDetails[0].bin` integer

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- ValidRequest — Installments options response body information.
  - `value` number, required — Value to be paid in installments.
  - `installments` object[], required — Installments information.
    - `payment` object, required — Payment system information.
      - `id` integer, required — Payment system identification.
      - `name` string, nullable, required — Payment system name.
      - `bin` string, nullable, required — First six digits of the card number.
      - `value` number, required — Value to be paid in installments.
      - `isDefault` boolean, required — Indicates whether the payment system is automatically applied by default.
      - `self` object, required — Object containing the payment system reference route.
        - `href` string, required — Payment system reference route.
    - `options` Option[], required — Array containing information about installment options.
      - `ruleId` string, nullable, required — Rule identification.
      - `quantity` integer, required — Number of installments.
      - `value` number, required — Value of each installment.
      - `interestRate` number, required — Interest rate (percent 0.1 = 10%).
      - `isExternalInstallmentService` number, nullable, required — Indicates the external installment system (if applicable).
      - `interestTax` number, nullable, required — Interest tax (percent 0.1 = 10%).

## Other responses

- `400` — Bad Request

## Changes

- **2024-06-10** `aca4931fa22b` — 2 info
  - the endpoint scheme security `VtexIdclientAutCookie` was added to the API
  - the endpoint scheme security `appKey AND appToken` was added to the API
- **2024-01-16** `a38afb87a11b` — 1 breaking
  - the response property `installments/items/options/items/ruleId` became nullable for the status `200`

[Change history](https://skmtc.dev/vtex/apis/payments-gateway-api/changes/api/pvt/installments/get.md)

---

[API](https://skmtc.dev/vtex/apis/payments-gateway-api.md) · [All operations](https://skmtc.dev/vtex/apis/payments-gateway-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/payments-gateway-api/revisions/c1c6fd255d0e/schema)