VTEX · Schema

Payment

Payment information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Payment ID unique identifier in VTEX.
method string Payment method used for the buyer.
name string Payment name used for the buyer. This name could be the brand card or the VTEX payment method.
value number Payment value, with two decimal places separated by `.`.
currencyIso4217 string Currency used in each payment in the transaction, in ISO 4217 format.
installments integer Number of installments.
details object
View JSON Schema on GitHub

JSON Schema

vtex-payment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Payment",
  "title": "Payment",
  "description": "Payment information.",
  "required": [
    "id",
    "method",
    "value",
    "currencyIso4217",
    "installments"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Payment ID unique identifier in VTEX.",
      "example": "2D00FEBB"
    },
    "method": {
      "type": "string",
      "description": "Payment method used for the buyer.",
      "example": "CreditCard"
    },
    "name": {
      "type": "string",
      "description": "Payment name used for the buyer. This name could be the brand card or the VTEX payment method.",
      "example": "Visa"
    },
    "value": {
      "type": "number",
      "description": "Payment value, with two decimal places separated by `.`.",
      "example": 63.98
    },
    "currencyIso4217": {
      "type": "string",
      "description": "Currency used in each payment in the transaction, in ISO 4217 format.",
      "example": "BRL"
    },
    "installments": {
      "type": "integer",
      "description": "Number of installments.",
      "example": 3
    },
    "details": {
      "$ref": "#/components/schemas/Details"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-payment"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.