VTEX · Schema

UpdateAntifraudTransactionsoptionalRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string VTEX transaction ID. The ID of the transaction related with this payment.
reference string VTEX order reference key. The key of the order (from VTEX Orders system) related with this payment.
value integer VTEX transaction order value.
ip string The original IP address from the browser.
store string VTEX has a main name for the store. This unique name is often used in URL to access VTEX configurations.
deviceFingerprint string Device fingerprint generated by the provider. This is generated by using Google Tag Manager that the provider implements.
miniCart object
payments array Payments information.
hook string
View JSON Schema on GitHub

JSON Schema

vtex-updateantifraudtransactionsoptionalrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateAntifraudTransactionsoptionalRequest",
  "title": "UpdateAntifraudTransactionsoptionalRequest",
  "required": [
    "id",
    "reference",
    "value",
    "ip",
    "store",
    "deviceFingerprint",
    "miniCart",
    "payments",
    "hook"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "VTEX transaction ID. The ID of the transaction related with this payment.",
      "example": "D3AA1FC8372E430E8236649DB5EBD08E"
    },
    "reference": {
      "type": "string",
      "description": "VTEX order reference key. The key of the order (from VTEX Orders system) related with this payment.",
      "example": "v32478982vtx-01"
    },
    "value": {
      "type": "integer",
      "description": "VTEX transaction order value.",
      "example": 10
    },
    "ip": {
      "type": "string",
      "description": "The original IP address from the browser.",
      "example": "10.0.0.1"
    },
    "store": {
      "type": "string",
      "description": "VTEX has a main name for the store. This unique name is often used in URL to access VTEX configurations.",
      "example": "serasa"
    },
    "deviceFingerprint": {
      "type": "string",
      "description": "Device fingerprint generated by the provider. This is generated by using Google Tag Manager that the provider implements.",
      "example": "Generated_using_GTM_Store_Is_Responsible_To_Configure"
    },
    "miniCart": {
      "$ref": "#/components/schemas/MiniCart"
    },
    "payments": {
      "type": "array",
      "description": "Payments information.",
      "items": {
        "$ref": "#/components/schemas/Payment"
      }
    },
    "hook": {
      "type": "string"
    }
  }
}

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