VTEX · Schema

UserPaymentInfo

Structure with the order’s payment data. Required only if `invoiceData` is defined.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentMethods array List of strings with the payment methods used in the order. Required only if `invoiceData` is defined. The format and some possible values of payment methods accepted in this list can be found in the
View JSON Schema on GitHub

JSON Schema

vtex-userpaymentinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserPaymentInfo",
  "title": "UserPaymentInfo",
  "description": "Structure with the order\u2019s payment data. Required only if `invoiceData` is defined.",
  "required": [
    "paymentMethods"
  ],
  "type": "object",
  "properties": {
    "paymentMethods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of strings with the payment methods used in the order. Required only if `invoiceData` is defined. The format and some possible values of payment methods accepted in this list can be found in the call [Fetching marketplace information with the Orders API](https://developers.vtex.com/vtex-rest-api/docs/get-marketplace-data-orders-api).",
      "example": [
        "creditCardPaymentGroup"
      ]
    }
  },
  "example": {
    "paymentMethods": [
      "creditCardPaymentGroup"
    ]
  }
}

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-userpaymentinfo"
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.