payment-provider-protocol

Implement and validate VTEX Payment Provider Protocol connectors across required PPP endpoints.

39|9|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/vtex/ai-skills --skill payment-provider-protocol-vtex
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: payment-provider-protocol
Source: https://github.com/vtex/ai-skills/tree/main/tracks/payment/skills/payment-provider-protocol
Command: npx skills add https://github.com/vtex/ai-skills --skill payment-provider-protocol-vtex

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The PPP Skill provides a structured blueprint for building and validating a VTEX Payment Provider Protocol (PPP) connector, covering all required PPP endpoints and ensuring compliant, testable integration suitable for homologation.

Core Features & Use Cases

  • Comprehensive endpoint coverage spanning Manifest, Create Payment, Cancel, Capture/Settle, Refund, Inbound Request, and the nine PPP endpoints (including auth/token and credentials flows) to support full payment provider integration.
  • Enforced PPP request/response contracts to ensure exact field names, types, and timing across every endpoint.
  • Guidance for onboarding, testing, and homologation to reduce integration risk and ensure production readiness.

Quick Start

Set up your PPP-enabled connector project and begin homologation tests against the VTEX Payment Gateway.

Frequently Asked Questions about payment-provider-protocol

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build a VTEX Payment Provider Protocol connector?

To build a VTEX Payment Provider Protocol connector, you must implement required middleware endpoints for payments, cancellations, settlements, and refunds, enforcing exact request and response contracts for homologation readiness.

What endpoints are required for VTEX PPP integration?

VTEX PPP integration requires implementing endpoints for Manifest, Create Payment, Cancel, Capture/Settle, Refund, and Inbound Requests, along with auth/token and credentials flows for full payment provider integration.

What are the non-functional constraints for VTEX payment connectors?

VTEX payment connectors must adhere to non-functional constraints including HTTPS enforcement, specific TLS version requirements, strict latency limits, and safety checks to pass integration testing and homologation.

How do I debug a failing VTEX PPP connector during homologation?

Debugging a failing VTEX PPP connector involves validating endpoint response shapes, verifying exact field names and timing across all nine PPP endpoints, and checking compliance with TLS and latency constraints.

Does my payment middleware need to handle inbound requests for VTEX PPP?

Yes, your payment middleware must handle Inbound Request endpoints as part of the VTEX PPP specification to ensure full payment provider integration and pass required homologation tests.