VTEX · Schema

Installment

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
Value number
InterestRate number
TotalValuePlusInterestRate number
NumberOfInstallments integer
PaymentSystemName string
PaymentSystemGroupName string
Name string
View JSON Schema on GitHub

JSON Schema

vtex-installment-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Installment",
  "title": "Installment",
  "required": [
    "Value",
    "InterestRate",
    "TotalValuePlusInterestRate",
    "NumberOfInstallments",
    "PaymentSystemName",
    "PaymentSystemGroupName",
    "Name"
  ],
  "type": "object",
  "properties": {
    "Value": {
      "type": "number"
    },
    "InterestRate": {
      "type": "number"
    },
    "TotalValuePlusInterestRate": {
      "type": "number"
    },
    "NumberOfInstallments": {
      "type": "integer",
      "format": "int32"
    },
    "PaymentSystemName": {
      "type": "string"
    },
    "PaymentSystemGroupName": {
      "type": "string"
    },
    "Name": {
      "type": "string"
    }
  },
  "example": {
    "Value": 1000,
    "InterestRate": 0,
    "TotalValuePlusInterestRate": 1000,
    "NumberOfInstallments": 1,
    "PaymentSystemName": "American Express",
    "PaymentSystemGroupName": "creditCardPaymentGroup",
    "Name": "American Express \u00e0 vista"
  }
}