VTEX · Schema

Action

Actions information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentId string Payment identification.
payment object
date string Transaction settlement date.
type string Settlement action date.
value integer Transaction settlement value.
connectorResponse string Connector transaction response information. This object can return different fields according to the internal configuration of each connector (payment provider), for example, `Tid`, `ReturnCode`, `aut
View JSON Schema on GitHub

JSON Schema

vtex-action-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Action",
  "title": "Action",
  "required": [
    "paymentId",
    "payment",
    "date",
    "type",
    "value",
    "connectorResponse"
  ],
  "type": "object",
  "description": "Actions information.",
  "properties": {
    "paymentId": {
      "type": "string",
      "description": "Payment identification."
    },
    "payment": {
      "$ref": "#/components/schemas/Payment1"
    },
    "date": {
      "type": "string",
      "description": "Transaction settlement date."
    },
    "type": {
      "type": "string",
      "description": "Settlement action date."
    },
    "value": {
      "type": "integer",
      "description": "Transaction settlement value."
    },
    "connectorResponse": {
      "type": "string",
      "description": "Connector transaction response information. This object can return different fields according to the internal configuration of each connector (payment provider), for example, `Tid`, `ReturnCode`, `authId`, among others).",
      "nullable": true
    }
  }
}

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