VTEX · Example Payload

Vtex Manifest Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Manifest 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": "Manifest",
  "method": "GET",
  "path": "/manifest",
  "summary": "VTex List Anti-fraud Provider Manifest",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "response",
      "example": {
        "cardholderDocument": "required",
        "customFields": [
          {
            "name": "ApiKey",
            "type": "text"
          },
          {
            "name": "AnalysisLocation",
            "type": "select",
            "options": [
              {
                "text": "MEX",
                "value": "Latin America"
              },
              {
                "text": "USA",
                "value": "United States"
              }
            ]
          }
        ]
      }
    }
  ]
}