VTEX · Example Payload

Vtex Inboundrequestbeta Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Inboundrequestbeta 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

Raw ↑ 
{
  "operationId": "InboundRequest(BETA)",
  "method": "POST",
  "path": "/payments/{paymentId}/inbound/{action}",
  "summary": "VTex Inbound request (BETA)",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "requestId": "LA4E20D3B4E07B7E871F5B5BC9F91",
        "paymentId": "F5C1A4E20D3B4E07B7E871F5B5BC9F91",
        "responseData": {
          "statusCode": 200,
          "contentType": "application/json",
          "content": "{\"myAttribute\":\"anyValue\"}"
        },
        "connectorMetadata": [
          {
            "name": "MetadataName",
            "value": "MetadataValue"
          }
        ]
      }
    }
  ]
}