VTEX · Schema

Connector

Connector (payment provider) information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
implementation string Connector (payment provider) implementation class name.
affiliationId string Affiliation connector (payment provider) identification.
View JSON Schema on GitHub

JSON Schema

vtex-connector-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Connector",
  "title": "Connector",
  "required": [
    "implementation",
    "affiliationId"
  ],
  "type": "object",
  "description": "Connector (payment provider) information.",
  "nullable": true,
  "properties": {
    "implementation": {
      "type": "string",
      "description": "Connector (payment provider) implementation class name.",
      "example": "Vtex.PaymentGateway.Connectors.CieloV3Connector"
    },
    "affiliationId": {
      "type": "string",
      "description": "Affiliation connector (payment provider) identification.",
      "example": "0a8488e6-0c30-4150-be96-b0dcaaa6a0cd"
    }
  }
}