VTEX · Example Payload

Vtex Refundpayment Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Refundpayment Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "RefundPayment",
  "method": "POST",
  "path": "/payments/{paymentId}/refunds",
  "summary": "VTex Refund payment",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
        "refundId": "2EA354989E7E4BBC9F9D7B66674C2574",
        "value": 57,
        "code": null,
        "message": "Successfully refunded",
        "requestId": "LA4E20D3B4E07B7E871F5B5BC9F91",
        "connectorMetadata": [
          {
            "name": "MetadataName",
            "value": "MetadataValue"
          }
        ]
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "example": {
        "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
        "refundId": null,
        "value": 0,
        "code": "ERR123",
        "message": "Refund has failed due to an internal error",
        "requestId": "LA4E20D3B4E07B7E871F5B5BC9F91"
      }
    },
    {
      "status": "501",
      "contentType": "application/json",
      "example": {
        "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
        "refundId": null,
        "value": 0,
        "code": "refund-manually",
        "message": "This payment needs to be manually refunded",
        "requestId": "LA4E20D3B4E07B7E871F5B5BC9F91"
      }
    }
  ]
}

Work with this as data

Every example 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 examples

4 MCP tools reach this

find_examplesBrowse and filter every example 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 example

curl "https://apis.io/api/v1/examples/vtex-refundpayment-example"

All examples

curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.