skills.rest
exilonX
exilonXCOMMUNITY
Explore all skills by this author →
GitHub

payment-provider-protocol

Implement and validate VTEX Payment Provider Protocol endpoints with correct HTTP methods and response shapes.

Updated Mar 27, 2026
Search Tags:#payment gateway#vtex#homologation#payment provider protocol#connector implementation#ppp endpoints#api contract validation
One-click install
npx skills add https://github.com/exilonX/ap2 --skill payment-provider-protocol-exilonx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: payment-provider-protocol
Source: https://github.com/exilonX/ap2/tree/main/.agents/skills/payment-provider-protocol
Command: npx skills add https://github.com/exilonX/ap2 --skill payment-provider-protocol-exilonx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Skill reduces the risk of a VTEX payment connector failing homologation or breaking runtime payment flows by enforcing correct PPP endpoint coverage and strict request/response contracts.

Core Features & Use Cases

  • Implements all required PPP payment-flow endpoints: GET /manifest, POST /payments, POST /{paymentId}/cancellations, POST /{paymentId}/settlements, POST /{paymentId}/refunds, and POST /{paymentId}/inbound-request/{action}.
  • Ensures correct response shapes and HTTP semantics: validates that each endpoint returns every required field the VTEX Gateway expects for successful deserialization and state handling.
  • Supports merchant onboarding configuration (optional): covers Create Auth Token, Provider Auth Redirect, and Get Credentials to help providers integrate cleanly with the VTEX Admin setup.

Quick Start

Apply this skill to your connector by implementing the full VTEX Payment Provider Protocol endpoints and making sure each one returns the exact PPP response fields required by the 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 connector that passes homologation?▼

To pass VTEX payment connector homologation, expose the full Payment Provider Protocol endpoints over HTTPS on port 443 with TLS 1.2, strictly adhering to required HTTP methods and response shapes for payment-flow actions.

What VTEX Payment Provider Protocol endpoints are required for a gateway integration?▼

Required VTEX Payment Provider Protocol endpoints include GET /manifest, POST /payments, POST /{paymentId}/cancellations, POST /{paymentId}/settlements, POST /{paymentId}/refunds, and POST /{paymentId}/inbound-request/{action}.

Why does my VTEX payment provider integration fail during runtime payment flows?▼

VTEX payment provider integrations fail during runtime flows when connector endpoints omit required response fields, preventing the VTEX Gateway from deserializing data and correctly handling payment states.

Does the VTEX Payment Provider Protocol require TLS 1.2 for connector implementations?▼

Yes, the VTEX Payment Provider Protocol mandates HTTPS on port 443 with TLS 1.2 for connector implementations to ensure secure communication during payment processing and gateway homologation.

How do I configure supported payment methods in a VTEX payment manifest?▼

Configure supported payment methods in a VTEX payment manifest by correctly defining the paymentMethods configuration, ensuring the VTEX Gateway recognizes and routes the appropriate payment flows to your connector.

Can I handle merchant onboarding configuration with VTEX Payment Provider Protocol endpoints?▼

Yes, VTEX Payment Provider Protocol supports optional merchant onboarding configuration via Create Auth Token, Provider Auth Redirect, and Get Credentials endpoints to help providers integrate cleanly with VTEX Admin setup.

Related Skills

Explore More Software Engineering Skills→
vtexvtex
39

payment-provider-protocol

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

Official
Advanced
vtexdocsvtexdocs
39

payment-provider-protocol

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

Official
Advanced
exilonXexilonX

payment-provider-framework

Implement VTEX IO payment connectors with PaymentProviderService and configuration validation.

Community
Advanced
vtexvtex
39

payment-provider-framework

Implement VTEX IO payment connectors with PaymentProvider and PaymentProviderService.

Official
Advanced