VTEX · Schema

Fields3

Fields information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
holderName	string	Card holder name.
cardNumber	number	Card number information.
validationCode	number	CVV code.
dueDate	string	Due date information. The date format is `mm/yy`.
document	string	Card holder documentation.
accountId	string	Account identification.
address	array	Array containing customer address information.
callbackUrl	string	Callback URL information.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Fields3",
  "title": "Fields3",
  "required": [
    "holderName",
    "cardNumber",
    "validationCode",
    "dueDate",
    "document",
    "accountId",
    "address",
    "callbackUrl"
  ],
  "type": "object",
  "description": "Fields information.",
  "properties": {
    "holderName": {
      "type": "string",
      "description": "Card holder name.",
      "example": "UserTest"
    },
    "cardNumber": {
      "type": "number",
      "description": "Card number information.",
      "example": 111111111111
    },
    "validationCode": {
      "type": "number",
      "description": "CVV code.",
      "example": 231
    },
    "dueDate": {
      "type": "string",
      "description": "Due date information. The date format is `mm/yy`.",
      "example": "10/19"
    },
    "document": {
      "type": "string",
      "description": "Card holder documentation.",
      "example": "8041734561"
    },
    "accountId": {
      "type": "string",
      "description": "Account identification.",
      "example": "08134AF761A148B9A5DCE14A81F31DD9",
      "nullable": true
    },
    "address": {
      "type": "array",
      "description": "Array containing customer address information.",
      "items": {
        "type": "string",
        "description": "Customer address information.",
        "example": "Customer address data"
      },
      "nullable": true
    },
    "callbackUrl": {
      "type": "string",
      "description": "Callback URL information.",
      "example": "https://payment-test.myvtex.com/checkout/gatewayCallback/1336650505288/Success",
      "nullable": true
    }
  }
}