Vtex Affiliations 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
{
"operationId": "Affiliations",
"method": "GET",
"path": "/api/pvt/affiliations",
"summary": "VTex List all affiliations",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": [
{
"id": "c4c0d24d-b9b8-468d-af98-916b4ada930d",
"implementation": "Vtex.PaymentGateway.Connectors.CieloV3Connector",
"name": "CieloV3 - 3ds2 prod",
"configuration": [
{
"name": "HowTo",
"value": "https://developercielo.github.io/payment-method-enablement/",
"valueKey": null
},
{
"name": "MerchantId",
"value": "56b93f46-2b3a-480f-8f9e-ec8e1fde97c0",
"valueKey": null
},
{
"name": "MerchantKey",
"value": "**********",
"valueKey": null
},
{
"name": "softDescriptor",
"value": "vtex test",
"valueKey": null
},
{
"name": "bankInvoiceProvider",
"value": "BancoDoBrasil2",
"valueKey": null
},
{
"name": "bankDebitProvider",
"value": "BancoDoBrasil",
"valueKey": null
},
{
"name": "Registered",
"value": "true",
"valueKey": null
},
{
"name": "use3ds",
"value": "true",
"valueKey": null
},
{
"name": "EstablishmentCode",
"value": "1119338171",
"valueKey": null
},
{
"name": "MerchantName",
"value": "VTEX",
"valueKey": null
},
{
"name": "MCC",
"value": "7372",
"valueKey": null
},
{
"name": "ClientId",
"value": "6b4853d7-44f8-4c58-8d48-811d4cb49e1a",
"valueKey": null
},
{
"name": "ClientSecret",
"value": "**********",
"valueKey": null
},
{
"name": "BpmpiAuth",
"value": "true",
"valueKey": null
},
{
"name": "BpmpiAuthNotifyOnly",
"value": "false",
"valueKey": null
},
{
"name": "BpmpiAuthSuppresschallenge",
"value": "false",
"valueKey": null
},
{
"name": "useEarlySecurityCapture",
"value": "0",
"valueKey": null
},
{
"name": "autoSettleDelay",
"value": "",
"valueKey": null
},
{
"name": "isProduction",
"value": "true",
"valueKey": null
}
],
"isdelivered": true,
"isConfigured": true
},
{
"id": "42bc3c4c-f8ca-4be0-870c-edfe263546b6",
"implementation": "Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector",
"name": "Gift Card",
"configuration": [
{
"name": "usesOnlineRefund",
"value": "true",
"valueKey": null
},
{
"name": "useEarlySecurityCapture",
"value": "1",
"valueKey": null
}
],
"isdelivered": true,
"isConfigured": true
},
{
"id": "1bd6e98e-6986-4ff3-ab58-78a37bd2a2ef",
"implementation": "Vtex.PaymentGateway.Connectors.AdyenConnector",
"name": "Adyen",
"configuration": [
{
"name": "username",
"value": "ws_399958@Company.VtexBR",
"valueKey": null
},
{
"name": "password",
"value": "**********",
"valueKey": null
},
{
"name": "account",
"value": "VTEXPubliEventos",
"valueKey": null
},
{
"name": "liveEndpointPrefix",
"value": "99e86b1244882cda-VtexBR",
"valueKey": null
},
{
"name": "marketPayAccount",
"value": "",
"valueKey": null
},
{
"name": "marketPayCommission",
"value": "",
"valueKey": null
},
{
"name": "subMerchantId",
"value": "",
"valueKey": null
},
{
"name": "Currency",
"value": "BRL",
"valueKey": null
},
{
"name": "Brand",
"value": "boletobancario_bradesco",
"valueKey": null
},
{
"name": "ShopperStatement",
"value": "",
"valueKey": null
},
{
"name": "SoftDescriptor",
"value": "",
"valueKey": null
},
{
"name": "SkinCode",
"value": "",
"valueKey": null
},
{
"name": "LanguageCode",
"value": "pt",
"valueKey": null
},
{
"name": "expirationDays",
"value": "7",
"valueKey": null
},
{
"name": "HmacKey",
"value": "",
"valueKey": null
},
{
"name": "useMultipleRefund",
"value": "false",
"valueKey": null
},
{
"name": "use3DS",
"value": "true",
"valueKey": null
},
{
"name": "threeDSecureMode",
"value": "3ds2-auth",
"valueKey": null
},
{
"name": "requireLiabilityShift",
"value": "false",
"valueKey": null
},
{
"name": "applePay_MerchantId",
"value": "",
"valueKey": null
},
{
"name": "applePay_MerchantCertificate",
"value": null,
"valueKey": null
},
{
"name": "applePay_MerchantPassword",
"value": "",
"valueKey": null
},
{
"name": "autoSettle",
"value": "4",
"valueKey": null
},
{
"name": "countryCode",
"value": "AT",
"valueKey": null
},
{
"name": "useEarlySecurityCapture",
"value": "0",
"valueKey": null
},
{
"name": "useAntifraud",
"value": "false",
"valueKey": null
},
{
"name": "isProduction",
"value": "true",
"valueKey": null
},
{
"name": "LinkHelp",
"value": "",
"valueKey": null
}
],
"isdelivered": true,
"isConfigured": true
},
{
"id": "400b66d3-bc9a-4eb8-afc0-f32fe63c7121",
"implementation": "Vtex.PaymentGateway.Connectors.BankIssuedInvoiceItauConnector",
"name": "BankInvoice Itau",
"configuration": [
{
"name": "CompanyName",
"value": "TESTE",
"valueKey": null
},
{
"name": "Document",
"value": "1111111111111111",
"valueKey": null
},
{
"name": "BranchCode",
"value": "1158",
"valueKey": null
},
{
"name": "Account",
"value": "1160",
"valueKey": null
},
{
"name": "ExpiryDays",
"value": "5",
"valueKey": null
},
{
"name": "Instructions",
"value": "xpto",
"valueKey": null
},
{
"name": "Portfolio",
"value": "11",
"valueKey": null
},
{
"name": "BankAgreement",
"value": "000111",
"valueKey": null
},
{
"name": "TransferorCode",
"value": "a",
"valueKey": null
},
{
"name": "companyAddress",
"value": "",
"valueKey": null
},
{
"name": "Registered",
"value": "true",
"valueKey": null
},
{
"name": "configurationTemplate",
"value": "{\"name\":\"Registered\",\"template\":[{\"value\":\"true\",\"configuration\":[{\"name\":\"AuthEnvironment\",\"hidden\":false},{\"name\":\"EnvironmentType\",\"hidden\":false},{\"name\":\"ClientId\",\"hidden\":false},{\"name\":\"ClientSecret\",\"hidden\":false},{\"name\":\"ItauKey\",\"hidden\":false}]}]}",
"valueKey": null
},
{
"name": "AuthEnvironment",
"value": "",
"valueKey": null
},
{
"name": "EnvironmentType",
"value": "",
"valueKey": null
},
{
"name": "ClientId",
"value": "",
"valueKey": null
},
{
"name": "ClientSecret",
"value": "",
"valueKey": null
},
{
"name": "ItauKey",
"value": "",
"valueKey": null
},
{
"name": "TransactionExpirationDays",
"value": "20",
"valueKey": null
},
{
"name": "isProduction",
"value": "true",
"valueKey": null
}
],
"isdelivered": true,
"isConfigured": true
},
{
"id": "1d884ffd-13d7-419e-a487-da55a2205792",
"implementation": "Vtex.PaymentGateway.Connectors.TestConnector",
"name": "Test Connector",
"configuration": [
{
"name": "OperationTime",
"value": "1000",
"valueKey": null
},
{
"name": "applePay_MerchantId",
"value": "",
"valueKey": null
},
{
"name": "applePay_MerchantCertificate",
"value": null,
"valueKey": null
},
{
"name": "applePay_MerchantPassword",
"value": "",
"valueKey": null
},
{
"name": "SamsungPayServiceId",
"value": "",
"valueKey": null
}
],
"isdelivered": false,
"isConfigured": true
}
]
}
]
}