VTEX · Schema

response5

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
value	number	Transaction value.
description	string	Transaction description.
date	string	Date of the transaction in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`).
requestId	string	VTEX request identifier.
settlement	object	Settlement transaction information.
cancellation	object	Cancellation transaction information.
authorization	object	Authorization transaction information.
operation	string	Operation information (`credit` or `debit`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/response5",
  "title": "response5",
  "type": "object",
  "properties": {
    "value": {
      "type": "number",
      "description": "Transaction value.",
      "example": 140
    },
    "description": {
      "type": "string",
      "description": "Transaction description.",
      "example": "GiftCardHub"
    },
    "date": {
      "type": "string",
      "description": "Date of the transaction in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`).",
      "example": "2023-06-02T18:24:49.252855Z"
    },
    "requestId": {
      "type": "string",
      "description": "VTEX request identifier.",
      "example": "3"
    },
    "settlement": {
      "type": "object",
      "description": "Settlement transaction information.",
      "properties": {
        "href": {
          "type": "string",
          "description": "Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.",
          "example": "/cosmetics2/giftcards/3b1abc17-988e-4a14-8b7f-31fc6a5b955c_70/transactions/faa6831230634c4b8fb897e02ba9c5a1/settlements"
        }
      }
    },
    "cancellation": {
      "type": "object",
      "description": "Cancellation transaction information.",
      "properties": {
        "href": {
          "type": "string",
          "description": "Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.",
          "example": "/cosmetics2/giftcards/3b1abc17-988e-4a14-8b7f-31fc6a5b955c_70/transactions/faa6831230634c4b8fb897e02ba9c5a1/cancellations"
        }
      }
    },
    "authorization": {
      "type": "object",
      "description": "Authorization transaction information.",
      "properties": {
        "href": {
          "type": "string",
          "description": "Gift card resource URL. The first number described in the URL refers to the gift card identification. The second number, refers to the transaction identification.",
          "example": "/cosmetics2/giftcards/3b1abc17-988e-4a14-8b7f-31fc6a5b955c_70/transactions/faa6831230634c4b8fb897e02ba9c5a1/authorization"
        }
      }
    },
    "operation": {
      "type": "string",
      "description": "Operation information (`credit` or `debit`).",
      "example": "Credit"
    }
  }
}