VTEX · Schema

PaymentSystem

Payment system information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id number Payment system identification.
name string Payment system name.
implementation string Payment system implementation class name.
View JSON Schema on GitHub

JSON Schema

vtex-paymentsystem-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PaymentSystem",
  "title": "PaymentSystem",
  "required": [
    "id",
    "name",
    "implementation"
  ],
  "type": "object",
  "description": "Payment system information.",
  "properties": {
    "id": {
      "type": "number",
      "description": "Payment system identification.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Payment system name.",
      "example": "CieloV3 - Test"
    },
    "implementation": {
      "type": "string",
      "description": "Payment system implementation class name.",
      "example": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
      "nullable": true
    }
  }
}