VTEX · Schema

Success

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
cardholderDocument string Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`.
customFields array Custom fields information.
View JSON Schema on GitHub

JSON Schema

vtex-success-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Success",
  "title": "Success",
  "required": [
    "customFields"
  ],
  "type": "object",
  "properties": {
    "cardholderDocument": {
      "type": "string",
      "description": "Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`."
    },
    "customFields": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "description": "Custom fields information."
    }
  },
  "example": {
    "customFields": [
      {
        "name": "ApiKey",
        "type": "text"
      },
      {
        "name": "AnalysisLocation",
        "type": "select",
        "options": [
          {
            "text": "MEX",
            "value": "Latin America"
          },
          {
            "text": "USA",
            "value": "United States"
          }
        ]
      }
    ]
  }
}