VTEX · Schema

InsertAffiliationRequest

Insert new affiliation request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
implementation	string	Provider implementation class name.
name	string	Provider name.
configuration	array	Array containing provider configuration information.
isdelivered	boolean	Indicates whether the provider is published and available for use.
isConfigured	boolean	Indicates whether the provider is configured.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InsertAffiliationRequest",
  "title": "InsertAffiliationRequest",
  "type": "object",
  "description": "Insert new affiliation request body information.",
  "required": [
    "implementation",
    "name",
    "configuration",
    "isdelivered",
    "isConfigured"
  ],
  "properties": {
    "implementation": {
      "type": "string",
      "description": "Provider implementation class name.",
      "example": "Vtex.PaymentGateway.Connectors.CieloV3Connector"
    },
    "name": {
      "type": "string",
      "description": "Provider name.",
      "example": "CieloV3 - Test"
    },
    "configuration": {
      "type": "array",
      "description": "Array containing provider configuration information.",
      "items": {
        "type": "object",
        "description": "Provider configuration information.",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Configuration parameter name.",
            "example": "MerchantId"
          },
          "value": {
            "type": "string",
            "description": "Configuration parameter value.",
            "example": "sampleData"
          }
        }
      }
    },
    "isdelivered": {
      "type": "boolean",
      "description": "Indicates whether the provider is published and available for use.",
      "example": true
    },
    "isConfigured": {
      "type": "boolean",
      "description": "Indicates whether the provider is configured.",
      "example": true
    }
  },
  "example": {
    "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
    "name": "CieloV3 - Test",
    "configuration": [
      {
        "name": "HowTo",
        "value": "https://developercielo.github.io/payment-method-enablement/"
      },
      {
        "name": "MerchantId",
        "value": "sampleData"
      },
      {
        "name": "MerchantKey",
        "value": "**********"
      },
      {
        "name": "softDescriptor",
        "value": "teste"
      },
      {
        "name": "bankInvoiceProvider",
        "value": "Disabled"
      },
      {
        "name": "bankIDebitProvider",
        "value": "Disabled"
      },
      {
        "name": "useEarlySecurityCapture",
        "value": "0"
      },
      {
        "name": "isProduction",
        "value": "false"
      },
      {
        "name": "bankDebitProvider",
        "value": "Disabled"
      },
      {
        "name": "Registered",
        "value": "false"
      }
    ],
    "isdelivered": true,
    "isConfigured": true
  }
}