payment-provider-protocol

Implement VTEX Payment Provider Protocol PPP connectors with endpoint contracts and manifest requirements.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive blueprint and guardrails to implement a VTEX Payment Provider Protocol (PPP) connector that passes homologation and integrates with the VTEX Payment Gateway.

Core Features & Use Cases

  • Implements all PPP endpoints (Manifest, Create Payment, Cancel, Capture/Settle, Refund, Inbound Request, plus optional auth token, provider redirect, and credentials) and enforces correct response shapes, TLS requirements, and performance constraints.
  • Guides debugging, configuration flow, and endpoint decision rules for reliable, compliant payment integrations across VTEX platforms.
  • Use Case: A developer wires a new PSP through the PPP middleware to support merchant onboarding and live payment flows.

Quick Start

Implement a PPP connector following the included endpoint contracts and manifest requirements to achieve homologation-ready integration.

Frequently Asked Questions about payment-provider-protocol

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

FAQPage Schema
How do I implement a VTEX Payment Provider Protocol connector that passes homologation?

To implement a VTEX Payment Provider Protocol connector that passes homologation, follow a production-ready blueprint enforcing endpoint contracts, manifest accuracy, TLS requirements, and performance constraints across all 9 PPP endpoints and configuration flows.

What is the VTEX Payment Provider Protocol and when do I need it for payment integration?

The VTEX Payment Provider Protocol (PPP) is a middleware standard for integrating external payment service providers with the VTEX Payment Gateway. You need it when building or debugging a connector to support merchant onboarding and live payment flows.

Which endpoints must a VTEX payment provider implement for full PPP compliance?

Full PPP compliance requires implementing Manifest, Create Payment, Cancel, Capture/Settle, Refund, and Inbound Request endpoints, plus optional auth token, provider redirect, and credentials endpoints, enforcing correct response shapes and security constraints.

Why does my VTEX payment connector fail homologation during the configuration flow?

VTEX payment connectors fail homologation due to incorrect response shapes, manifest inaccuracies, missing TLS requirements, or performance constraint violations. Debugging requires verifying endpoint decision rules and configuration flows against the PPP contract blueprint.

Can I use this PPP blueprint to debug an existing VTEX payment provider integration?

Yes, you can use this PPP blueprint to debug an existing VTEX payment provider integration. It guides endpoint decision rules, configuration flows, and response shape enforcement for reliable, compliant payment integrations across VTEX platforms.