VTEX · Schema

Success3

Refund payment response body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentId string The same `paymentId` sent in the request.
refundId string Provider's refund identifier. If the operation has failed you **MUST** return `null`.
value number The amount that was refunded. If the operation has failed you **MUST** return `0`.
code string Provider's operation/error code to be logged. Return `refund-manually` if you do not support this operation, so we can send a notification to the merchant.
message string Provider's operation/error message to be logged.
requestId string The same `requestId` sent in the request.
connectorMetadata array Array containing metadata fields sent from the provider to the payment gateway.
View JSON Schema on GitHub

JSON Schema

vtex-success3-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Success3",
  "title": "Success3",
  "required": [
    "paymentId",
    "refundId",
    "value",
    "code",
    "message",
    "requestId"
  ],
  "type": "object",
  "description": "Refund payment response body information.",
  "properties": {
    "paymentId": {
      "type": "string",
      "description": "The same `paymentId` sent in the request."
    },
    "refundId": {
      "type": "string",
      "description": "Provider's refund identifier. If the operation has failed you **MUST** return `null`."
    },
    "value": {
      "type": "number",
      "description": "The amount that was refunded. If the operation has failed you **MUST** return `0`."
    },
    "code": {
      "type": "string",
      "nullable": true,
      "description": "Provider's operation/error code to be logged. Return `refund-manually` if you do not support this operation, so we can send a notification to the merchant."
    },
    "message": {
      "type": "string",
      "description": "Provider's operation/error message to be logged."
    },
    "requestId": {
      "type": "string",
      "description": "The same `requestId` sent in the request."
    },
    "connectorMetadata": {
      "type": "array",
      "description": "Array containing metadata fields sent from the provider to the payment gateway.",
      "items": {
        "type": "object",
        "description": "Metadata fields information.",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the metadata to be stored in the gateway (limited to 20 characters)."
          },
          "value": {
            "type": "string",
            "description": "The value of the metadata stored (limited to 200 characters)."
          }
        }
      }
    }
  }
}

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