VTEX · Schema

RefundthetransactionRequest

Refund transaction request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
value number Purchase value. The value must be described without using separation for decimals, e.g. to capture a value of 320.50, send 32050.
freight number Freigth value, if applicable.
tax number Tax value, if applicable.
minicart object This field is filled with the content of the cart of the transaction, which can be obtained using [Get Orders](https://developers.vtex.com/docs/api-reference/orders-api?endpoint=get-/api/oms/pvt/order
View JSON Schema on GitHub

JSON Schema

vtex-refundthetransactionrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RefundthetransactionRequest",
  "title": "RefundthetransactionRequest",
  "required": [
    "value"
  ],
  "type": "object",
  "description": "Refund transaction request body information.",
  "properties": {
    "value": {
      "type": "number",
      "description": "Purchase value. The value must be described without using separation for decimals, e.g. to capture a value of 320.50, send 32050."
    },
    "freight": {
      "type": "number",
      "description": "Freigth value, if applicable."
    },
    "tax": {
      "type": "number",
      "description": "Tax value, if applicable."
    },
    "minicart": {
      "type": "object",
      "description": "This field is filled with the content of the cart of the transaction, which can be obtained using [Get Orders](https://developers.vtex.com/docs/api-reference/orders-api?endpoint=get-/api/oms/pvt/orders/-orderId-) or [Transaction Details](https://developers.vtex.com/docs/api-reference/payments-gateway-api?endpoint=get-/api/pvt/transactions/-transactionId-) endpoints. It should only be included for transactions with split payment.",
      "items": {
        "type": "array",
        "description": "Array containing cart items.",
        "items": {
          "type": "object",
          "description": "Cart items information.",
          "properties": {
            "id": {
              "type": "string",
              "description": "Item identifier.",
              "example": "122323"
            },
            "name": {
              "type": "string",
              "description": "Item name.",
              "example": "Tenis Preto I"
            },
            "value": {
              "type": "number",
              "description": "Item value.",
              "example": 1000
            },
            "shippingDiscount": {
              "type": "integer",
              "description": "Discount to be applied for the shipping value.",
              "example": 0
            },
            "discount": {
              "type": "integer",
              "description": "Discount applied on item.",
              "example": 50
            }
          }
        }
      }
    }
  }
}

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