Menu
Guides
API Reference
App Development
Storefront Development
VTEX IO Apps
Troubleshooting
Release Notes
Guides
VTEX Platform Overview
API usage
Getting started
VTEX AI Developer Toolkit
FastStore monorepo
VTEX Business models
Integration Guides
Catalog
Checkout
CMS
Master Data
Payments
Orders
Logistics
B2B
VTEX Sales App
UI Customization
Message Center
Pricing
Promotions
Infrastructure
Search
Recommendations
VTEX Activity Flow
VTEX Ads
VTEX Session
VTEX Shield
Data Protection Plus
VTEX CX Platform (Weni)

PPP versioning

Learn how to set the Payment Provider Protocol version used by your payment connector to enable additional features.

2 min read

The Payment Provider Protocol (PPP) is the integration protocol between VTEX and payment processing partners. To enable new features without impacting existing operations, VTEX offers PPP versioning, which gives providers the flexibility to configure their connectors based on the solutions they want to offer.

This feature is currently in the testing phase (closed beta), which means that only select clients can access it. If you'd like to implement it in the future, contact our Support.

VTEX approves all payment connectors using PPP version 1.0.0, which corresponds to the standard protocol behavior. Declare the version field in the manifest only if you want to adopt a version with additional features.

Before you begin

Make sure you meet the following requirements:

RequirementDescription
Payment provider integrationYou must have a payment connector approved by VTEX and implemented in accordance with the Payment Provider Protocol.
Closed beta accessPPP versioning is restricted to select clients. Contact VTEX Technical Support to request access.
Version requirementsCheck the additional fields required by the version you want to adopt, as described in Features of PPP versions. Some versions require new fields in the manifest or in specific endpoints.

Configuring PPP versioning

To define the PPP version used for payment connector transactions, follow these instructions:

  1. Update the connector manifest by adding the version field with the desired version number, such as 2.0.0.


    _10
    {
    _10
    ...
    _10
    "version": "2.0.0",
    _10
    ...
    _10
    }

  2. Open a ticket with VTEX Technical Support to request the connector update. In the ticket, include the account name, the connector name, and the PPP version declared in the manifest.

VTEX applies the new version only after the connector update is processed. Until then, the connector keeps operating on its current version.

To restore the connector to standard PPP behavior, change the version field back to 1.0.0 and open a new ticket requesting the connector update.

Features of PPP versions

The following table describes the additional features available in each PPP version:

PPP versionFeatureDescription
1.0.0Standard protocol behaviorDefault version applied to all approved payment connectors. It requires no additional fields in the manifest.
2.0.0Payment tokenizationAllows you to manage credit card token information, improving the security of sensitive payment data during storage and transmission. It requires the cardToken object in the manifest, as described in Updating the connector manifest.

Next steps