What problem does it solve?
Payment connector implementations often fail or become risky because VTEX IO payment-provider wiring, configuration validation, and Secure Proxy rules are easy to get wrong and hard to debug later.
Core Features & Use Cases
- VTEX IO Payment Provider Framework setup: Guides correct wiring of
@vtex/payment-provider, PaymentProvider, and PaymentProviderService in node/index.ts, including the paymentProvider builder declaration and the /manifest and PPP route behaviors.
- Configuration and dependency correctness: Ensures
configuration.json uses only valid schema fields and that TypeScript Builder-Hub compatibility is maintained via TS 3.9.7-safe code and dependency pinning with resolutions.
- Secure Proxy PCI-safe card flows: Specifies when to use
SecureExternalClient with secureProxyUrl (authorize-only), proper content types, and how to separate post-auth operations that must call the PSP directly.
- Operational checklist for PSP integration: Covers base URL/path correctness, token caching needs, affiliation/testing workflow, and common failure modes that block homologation.
Use case example: You are implementing a new VTEX IO payment connector for a PSP and need to ensure the authorize flow goes through Secure Proxy while cancel/capture/refund call the PSP directly, with a configuration that passes strict builder validation.
Quick Start
Use the payment-provider-framework skill to implement your VTEX IO payment connector by wiring PaymentProviderService, validating paymentProvider/configuration.json, and setting up Secure Proxy authorize calls and direct PSP calls for post-auth operations.
