How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Installments API

The Installments API from VTEX — 1 operation(s) for installments.

VTEX Installments API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Installments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

1 operations 1 paths 6 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Installments API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Installments 1
GET
/api/pvt/installments
VTex Get installments options
Installmentsoptions 7 params → 200400

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Payment (6 properties), Option (6 properties), ValidRequest (2 properties), Installment (2 properties). Each schema is shown below with its type and property counts.

InvalidRequestValue
object
Installments options response body information.
1 property 1 required
Option
object
Installment options information.
6 properties 6 required
Installment
object
Installment options information.
2 properties 2 required
ValidRequest
object
Installments options response body information.
2 properties 2 required
Self
object
Object containing the payment system reference route.
1 property 1 required
Payment
object
Payment system information.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-installments-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Authentication API
VTEX Autocomplete API
VTEX Brand API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
Where this information came from

This is an independent, third-party profile of VTEX Installments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.