payment-provider-framework

Implement VTEX IO payment connectors with PaymentProvider and PaymentProviderService.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a comprehensive blueprint for designing and implementing a VTEX IO payment connector, ensuring a correct, standards-compliant integration with the Payment Provider Framework.

Core Features & Use Cases

  • IO-based integration: Wire PaymentProvider and PaymentProviderService inside a VTEX IO app to expose PPP routes.
  • Config-driven: Manage connectors with manifest.json and configuration.json, including supported payment methods and secure proxy usage.
  • Guided workflow: Covers prerequisites, testing flow, and homologation steps for production deployment.

Quick Start

Follow these steps to bootstrap your first VTEX IO payment connector and wire it into the provider framework.

Frequently Asked Questions about payment-provider-framework

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

FAQPage Schema
How do I build a VTEX IO payment connector?

To build a VTEX IO payment connector, wire PaymentProvider and PaymentProviderService inside an IO app, configure manifest.json and configuration.json with real methods, and implement PPP routes for transaction processing.

What is the Payment Provider Framework in VTEX IO?

The Payment Provider Framework is a VTEX IO standard that enables apps to expose PPP routes for payment processing, ensuring correct integration between custom connectors and the platform's checkout flow.

How do I configure Secure Proxy for a VTEX payment provider?

Configuring the Secure Proxy involves using the Secure External Client with allowlisted destinations in your VTEX IO app, ensuring outbound payment requests are routed securely through the Payment Provider Framework.

Do I need the paymentProvider builder to create a VTEX IO connector?

Yes, the paymentProvider builder is a mandatory prerequisite. You must declare it in your manifest.json to properly wire the PaymentProvider and PaymentProviderService interfaces for your connector.

What are the requirements for configuration.json in a VTEX payment connector?

The configuration.json must define real, supported payment methods and connector settings. A valid configuration file is a strict prerequisite before implementing PPP routes and testing the integration.

How do I test and homologate a VTEX IO payment connector?

Testing and homologating a VTEX IO payment connector requires following the guided workflow to validate PPP routes, Secure Proxy configurations, and configuration.json methods before production deployment.