VTEX · Example Payload

Vtex Installmentsoptions Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Installmentsoptions Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "Installmentsoptions",
  "method": "GET",
  "path": "/api/pvt/installments",
  "summary": "VTex Get installments options",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "value": 250,
        "installments": [
          {
            "payment": {
              "id": 72,
              "name": null,
              "bin": null,
              "value": 250,
              "isDefault": false,
              "self": {
                "href": "/api/pvt/payment-systems/72"
              }
            },
            "options": [
              {
                "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04",
                "quantity": 1,
                "value": 250,
                "interestRate": 0,
                "isExternalInstallmentService": null,
                "interestTax": 0
              },
              {
                "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04",
                "quantity": 2,
                "value": 125,
                "interestRate": 0,
                "isExternalInstallmentService": null,
                "interestTax": 0
              },
              {
                "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04",
                "quantity": 3,
                "value": 83.33,
                "interestRate": 0,
                "isExternalInstallmentService": null,
                "interestTax": 0
              },
              {
                "ruleId": "01a8d68b-9116-4655-83f8-3380f658ec04",
                "quantity": 4,
                "value": 62.5,
                "interestRate": 0,
                "isExternalInstallmentService": null,
                "interestTax": 0
              }
            ]
          },
          {
            "payment": {
              "id": 5,
              "name": "ERedeV2 - Visa",
              "bin": null,
              "value": 10,
              "isDefault": false,
              "self": {
                "href": "/api/pvt/payment-systems/2"
              }
            },
            "options": [
              {
                "ruleId": "993d4d35-b64d-454d-8108-c560580160e0",
                "quantity": 1,
                "value": 250,
                "interestRate": 0,
                "isExternalInstallmentService": null,
                "interestTax": null
              }
            ]
          },
          {
            "payment": {
              "id": 12,
              "name": "PayPal - 6U0DTI3M3OKO6R",
              "bin": null,
              "value": 10,
              "isDefault": false,
              "self": {
                "href": "/api/pvt/payment-systems/12"
              }
            },
            "options": [
              {
                "ruleId": "9ac0fa1b-dd9d-4549-abb8-e73bbb63c280",
                "quantity": 1,
                "value": 250,
                "interestRate": 0,
                "isExternalInstallmentService": null,
                "interestTax": null
              }
            ]
          }
        ]
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "error": {
          "code": "1",
          "message": "Value must be greater than Zero",
          "exception": null
        }
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/vtex-installmentsoptions-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.