VTEX · Schema

Payment1

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	Payment ID.
paymentSystem	string	Payment system ID.
paymentSystemName	string	Payment system name.
value	integer	Payment value.
installments	integer	Payment Installments quantity.
referenceValue	integer	Payment reference Value.
cardHolder	string	Payment card holder.
cardNumber	string	Payment card number.
firstDigits	string	Payment card first digits.
lastDigits	string	Payment card last digits.
cvv2	string	Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions.
expireMonth	string	Payment card expire month.
expireYear	string	Payment card expire year.
url	string	Payment URL.
giftCardId	string	Gift Card ID.
giftCardName	string	Gift Card name.
giftCardCaption	string	Gift Card caption.
redemptionCode	string	Code for the customer to use the Gift Card.
group	string	It represents the payment method. For each method, it can have the following values: - Credit card: `creditCard` - Debid card: `debitCard` - Bank invoice: `bankInvoice` - Promissory: `
tid	string	Payment transaction ID.
dueDate	string	Payment due date.
connectorResponses	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Payment1",
  "title": "Payment1",
  "required": [
    "id",
    "paymentSystem",
    "paymentSystemName",
    "value",
    "installments",
    "referenceValue",
    "cardHolder",
    "cardNumber",
    "firstDigits",
    "lastDigits",
    "cvv2",
    "expireMonth",
    "expireYear",
    "url",
    "giftCardId",
    "giftCardName",
    "giftCardCaption",
    "redemptionCode",
    "group",
    "tid",
    "dueDate",
    "connectorResponses"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Payment ID."
    },
    "paymentSystem": {
      "type": "string",
      "description": "Payment system ID."
    },
    "paymentSystemName": {
      "type": "string",
      "description": "Payment system name."
    },
    "value": {
      "type": "integer",
      "description": "Payment value."
    },
    "installments": {
      "type": "integer",
      "description": "Payment Installments quantity."
    },
    "referenceValue": {
      "type": "integer",
      "description": "Payment reference Value."
    },
    "cardHolder": {
      "type": "string",
      "nullable": true,
      "description": "Payment card holder."
    },
    "cardNumber": {
      "type": "string",
      "nullable": true,
      "description": "Payment card number."
    },
    "firstDigits": {
      "type": "string",
      "description": "Payment card first digits."
    },
    "lastDigits": {
      "type": "string",
      "description": "Payment card last digits."
    },
    "cvv2": {
      "type": "string",
      "nullable": true,
      "description": "Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions."
    },
    "expireMonth": {
      "type": "string",
      "nullable": true,
      "description": "Payment card expire month."
    },
    "expireYear": {
      "type": "string",
      "nullable": true,
      "description": "Payment card expire year."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "description": "Payment URL."
    },
    "giftCardId": {
      "type": "string",
      "nullable": true,
      "description": "Gift Card ID."
    },
    "giftCardName": {
      "type": "string",
      "nullable": true,
      "description": "Gift Card name."
    },
    "giftCardCaption": {
      "type": "string",
      "nullable": true,
      "description": "Gift Card caption."
    },
    "redemptionCode": {
      "type": "string",
      "nullable": true,
      "description": "Code for the customer to use the Gift Card."
    },
    "group": {
      "type": "string",
      "description": "It represents the payment method. For each method, it can have the following values: \n\r\n- **Credit card:** `creditCard` \r\n\r\n- **Debid card:** `debitCard`\r\n\r\n- **Bank invoice:** `bankInvoice`\r\n\r\n- **Promissory:** `promissory` \r\n\r\n- **Gift card:** `giftCard` \n\r\n- **Pix:** `instantPayment`."
    },
    "tid": {
      "type": "string",
      "description": "Payment transaction ID."
    },
    "dueDate": {
      "type": "string",
      "nullable": true,
      "description": "Payment due date."
    },
    "connectorResponses": {
      "$ref": "#/components/schemas/ConnectorResponses"
    }
  },
  "example": {
    "id": "721CBE1090324D12ABE301FE33DE775A",
    "paymentSystem": "4",
    "paymentSystemName": "Mastercard",
    "value": 10150,
    "installments": 1,
    "referenceValue": 10150,
    "cardHolder": null,
    "cardNumber": null,
    "firstDigits": "412341",
    "lastDigits": "4123",
    "cvv2": null,
    "expireMonth": null,
    "expireYear": null,
    "url": null,
    "giftCardId": null,
    "giftCardName": null,
    "giftCardCaption": null,
    "redemptionCode": null,
    "group": "creditCard",
    "tid": "101770752",
    "dueDate": null,
    "connectorResponses": {
      "Tid": "101770752",
      "ReturnCode": "200",
      "Message": "logMessage",
      "authId": "170852"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema

curl "https://apis.io/api/v1/json-schemas/vtex-payment1"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

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

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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