v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-202547455.8 KB

Configuration

Get affiliation by ID

Returns data for a specific affiliation (payment or anti-fraud provider).

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:

Product	Category	Resource
PCI Gateway	Payment-Make Payments	View 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/{affiliationId}

Path parameters

affiliationIdstring required

Example:e046d326-5421-45ab-95ae-f13d37f260b5

Affiliation (payment or anti-fraud provider) identification.

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

idstring required

Provider identification.

implementationstring required

Provider implementation class name.

namestring required

Provider name.

isdeliveredboolean required

Indicates whether the provider is published and available for use.

isConfiguredboolean required

Indicates whether the provider is configured.