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

vtex-insertaffiliationrequest-schema.json Raw ↑
{
  "$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
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-insertaffiliationrequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.