VTEX · Schema

SettleResponse

Transaction response body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Settle request identification.
token string Token identification.
status number Status code.
statusDetail string Status detail information.
processingDate string Settlement processing date.
refundedValue integer Refunded value.
refundedToken string Refund operation token.
message string Custom message.
code string Custom code.
connectorRefundedValue number Refunded value by connector (provider).
cancelledValue integer Cancelled value.
View JSON Schema on GitHub

JSON Schema

vtex-settleresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SettleResponse",
  "title": "SettleResponse",
  "required": [
    "id",
    "token",
    "status",
    "statusDetail",
    "processingDate",
    "refundedValue",
    "refundedToken",
    "message",
    "code",
    "connectorRefundedValue",
    "cancelledValue"
  ],
  "type": "object",
  "description": " Transaction response body information.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Settle request identification.",
      "nullable": true
    },
    "token": {
      "type": "string",
      "description": "Token identification."
    },
    "status": {
      "type": "number",
      "description": "Status code."
    },
    "statusDetail": {
      "type": "string",
      "description": "Status detail information."
    },
    "processingDate": {
      "type": "string",
      "description": "Settlement processing date."
    },
    "refundedValue": {
      "type": "integer",
      "description": "Refunded value."
    },
    "refundedToken": {
      "type": "string",
      "description": "Refund operation token.",
      "nullable": true
    },
    "message": {
      "type": "string",
      "description": "Custom message.",
      "nullable": true
    },
    "code": {
      "type": "string",
      "description": "Custom code.",
      "nullable": true
    },
    "connectorRefundedValue": {
      "type": "number",
      "description": "Refunded value by connector (provider)."
    },
    "cancelledValue": {
      "type": "integer",
      "description": "Cancelled value."
    }
  }
}

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