VTEX · Schema

1.CreateanewtransactionRequest

New transaction request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
value number Transaction value. The value must be described without using separation for decimals, e.g. for a transaction with a value equal to 201.50, send 20150.
referenceId string Identification number that relates the transaction to a purchase order.
channel string Store where the transaction was initiated.
urn string [URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.
salesChannel string Sales channel information.
View JSON Schema on GitHub

JSON Schema

vtex-1createanewtransactionrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/1.CreateanewtransactionRequest",
  "title": "1.CreateanewtransactionRequest",
  "required": [
    "value",
    "referenceId",
    "channel",
    "salesChannel"
  ],
  "type": "object",
  "description": "New transaction request body information.",
  "properties": {
    "value": {
      "type": "number",
      "description": "Transaction value. The value must be described without using separation for decimals, e.g. for a transaction with a value equal to 201.50, send 20150.",
      "example": 20000
    },
    "referenceId": {
      "type": "string",
      "description": "Identification number that relates the transaction to a purchase order.",
      "example": "1234567"
    },
    "channel": {
      "type": "string",
      "description": "Store where the transaction was initiated.",
      "example": "cosmetics2"
    },
    "urn": {
      "type": "string",
      "description": "[URN](https://en.wikipedia.org/wiki/Uniform_Resource_Name) information.",
      "example": "urn:amazon:webservices:clientvpn",
      "nullable": true
    },
    "salesChannel": {
      "type": "string",
      "description": "Sales channel information.",
      "example": "1"
    }
  }
}