VTEX · Schema

Action

Actions information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
paymentId string Payment identification.
payment object
date string Transaction settlement date.
type string Settlement action date.
value integer Transaction settlement value.
connectorResponse string Connector transaction response information. This object can return different fields according to the internal configuration of each connector (payment provider), for example, `Tid`, `ReturnCode`, `aut
View JSON Schema on GitHub

JSON Schema

vtex-action-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Action",
  "title": "Action",
  "required": [
    "paymentId",
    "payment",
    "date",
    "type",
    "value",
    "connectorResponse"
  ],
  "type": "object",
  "description": "Actions information.",
  "properties": {
    "paymentId": {
      "type": "string",
      "description": "Payment identification."
    },
    "payment": {
      "$ref": "#/components/schemas/Payment1"
    },
    "date": {
      "type": "string",
      "description": "Transaction settlement date."
    },
    "type": {
      "type": "string",
      "description": "Settlement action date."
    },
    "value": {
      "type": "integer",
      "description": "Transaction settlement value."
    },
    "connectorResponse": {
      "type": "string",
      "description": "Connector transaction response information. This object can return different fields according to the internal configuration of each connector (payment provider), for example, `Tid`, `ReturnCode`, `authId`, among others).",
      "nullable": true
    }
  }
}