VTEX · Schema

CurrencyFormatInfo

Object with currency format details.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
CurrencyDecimalDigits	integer	Quantity of currency decimal digits.
CurrencyDecimalSeparator	string	Defines what currency decimal separator will be applied.
CurrencyGroupSeparator	string	Defines what currency group separator will be applied.
CurrencyGroupSize	integer	Defines how many characters will be grouped.
StartsWithCurrencySymbol	boolean	Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CurrencyFormatInfo",
  "title": "CurrencyFormatInfo",
  "description": "Object with currency format details.",
  "required": [
    "CurrencyDecimalDigits",
    "CurrencyDecimalSeparator",
    "CurrencyGroupSeparator",
    "CurrencyGroupSize",
    "StartsWithCurrencySymbol"
  ],
  "type": "object",
  "properties": {
    "CurrencyDecimalDigits": {
      "type": "integer",
      "description": "Quantity of currency decimal digits."
    },
    "CurrencyDecimalSeparator": {
      "type": "string",
      "description": "Defines what currency decimal separator will be applied."
    },
    "CurrencyGroupSeparator": {
      "type": "string",
      "description": "Defines what currency group separator will be applied."
    },
    "CurrencyGroupSize": {
      "type": "integer",
      "description": "Defines how many characters will be grouped."
    },
    "StartsWithCurrencySymbol": {
      "type": "boolean",
      "description": "Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`)."
    }
  },
  "example": {
    "CurrencyDecimalDigits": 2,
    "CurrencyDecimalSeparator": ",",
    "CurrencyGroupSeparator": ".",
    "CurrencyGroupSize": 3,
    "StartsWithCurrencySymbol": true
  }
}