VTEX · Schema

TransactionInteractionsResponse

Array containing transaction interactions information.

CommerceE-CommerceRetailMarketplacePayments
View JSON Schema on GitHub

JSON Schema

vtex-transactioninteractionsresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransactionInteractionsResponse",
  "title": "TransactionInteractionsResponse",
  "required": [
    "Id",
    "PaymentId",
    "TransactionId",
    "Source",
    "Status",
    "Date",
    "Message",
    "Ticks"
  ],
  "type": "array",
  "description": "Array containing transaction interactions information.",
  "items": {
    "type": "object",
    "description": "Transaction interactions response body information.",
    "properties": {
      "Id": {
        "type": "string",
        "description": "Interaction identification."
      },
      "PaymentId": {
        "type": "string",
        "description": "Payment identification.",
        "nullable": true
      },
      "TransactionId": {
        "type": "string",
        "description": "Transaction identification."
      },
      "Source": {
        "type": "string",
        "description": "Origin of interaction in the VTEX system."
      },
      "Status": {
        "type": "string",
        "description": "Transaction status."
      },
      "Date": {
        "type": "string",
        "description": "Date of interaction in the transaction."
      },
      "Message": {
        "type": "string",
        "description": "Information about the action performed in the interaction."
      },
      "Ticks": {
        "type": "number",
        "description": "[Time span value](https://learn.microsoft.com/en-us/dotnet/api/system.timespan.ticks?view=net-8.0#remarks) information. A Tick is the smallest unit of time, equal to 100 nanoseconds or one ten-millionth of a second."
      }
    }
  }
}