VTEX · Example Payload

Vtex Affiliationbyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Affiliationbyid Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "AffiliationById",
  "method": "GET",
  "path": "/api/pvt/affiliations/{affiliationId}",
  "summary": "VTex Get affiliation by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "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_2",
            "valueKey": null
          },
          {
            "name": "MerchantKey",
            "value": "**********",
            "valueKey": null
          },
          {
            "name": "softDescriptor",
            "value": "teste_update",
            "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
      }
    }
  ]
}