Sign in
Configuration

List all affiliations

Returns all affiliations (payment and anti-fraud providers) that are already configured in your store.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
PCI GatewayPayment-Make PaymentsView Payment Data

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/pvt/affiliations

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

idstring

Provider identification.

implementationstring

Provider implementation class name.

namestring

Provider name.

isdeliveredboolean

Indicates whether the provider is published and available for use.

isConfiguredboolean

Indicates whether the provider is configured.

Changes

Changed in 3 of the 52 revisions of this API.72

  • aca4931fa22b2See the full diff
    • ○

      the endpoint scheme security VtexIdclientAutCookie was added to the API

      api-security-added

    • ○

      the endpoint scheme security appKey AND appToken was added to the API

      api-security-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a38afb87a11b1See the full diff
    • ▲

      the response property items/configuration/items/value became nullable for the status 200

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e6bea95b9c186See the full diff
    • ▲

      removed the required property configuration from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property implementation from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property isConfigured from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property isdelivered from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property name from the response with the 200 status

      response-required-property-removed