VTEX · Schema

UpdateAffiliationRequest

Update affiliation by ID request body information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	Provider identification.
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/UpdateAffiliationRequest",
  "title": "UpdateAffiliationRequest",
  "type": "object",
  "description": "Update affiliation by ID request body information.",
  "required": [
    "id",
    "implementation",
    "name",
    "configuration",
    "isdelivered",
    "isConfigured"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Provider identification.",
      "example": "fg8b4ea5-0b24-47dc-971e-2f6635ea1f14"
    },
    "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",
          "valueKey"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Configuration parameter name.",
            "example": "MerchantId"
          },
          "value": {
            "type": "string",
            "description": "Configuration parameter value.",
            "example": "sampleData"
          },
          "valueKey": {
            "type": "string",
            "description": "Value key information.",
            "example": "valuekey_1",
            "nullable": true
          }
        }
      }
    },
    "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": {
    "id": "fg8b4ea5-0b24-47dc-971e-2f6635ea1f14",
    "implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
    "name": "CieloV3 - Test",
    "configuration": [
      {
        "name": "HowTo",
        "value": "https://developercielo.github.io/payment-method-enablement/",
        "valueKey": null
      },
      {
        "name": "MerchantId",
        "value": "sampleData",
        "valueKey": null
      },
      {
        "name": "MerchantKey",
        "value": "**********",
        "valueKey": null
      },
      {
        "name": "softDescriptor",
        "value": "teste",
        "valueKey": null
      },
      {
        "name": "bankInvoiceProvider",
        "value": "Disabled",
        "valueKey": null
      },
      {
        "name": "bankIDebitProvider",
        "value": "Disabled",
        "valueKey": null
      },
      {
        "name": "useEarlySecurityCapture",
        "value": "0",
        "valueKey": null
      },
      {
        "name": "isProduction",
        "value": "false",
        "valueKey": null
      },
      {
        "name": "bankDebitProvider",
        "value": "Disabled",
        "valueKey": null
      },
      {
        "name": "Registered",
        "value": "false",
        "valueKey": null
      }
    ],
    "isdelivered": true,
    "isConfigured": true
  }
}