Skip to main content
skill CX Codex

payment-provider-framework — Claude Code skill: install

This skill guides VTEX IO payment connector work, from PPF wiring to Secure Proxy and build checks. Use it when implementing or maintaining a connector app.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add vtex/skills --skill payment-provider-framework -a claude-code
Open on GitHub

What payment-provider-framework does

The skill covers payment connectors built as VTEX IO apps. It explains how to wire @vtex/payment-provider, PaymentProvider, and PaymentProviderService, configure the paymentProvider builder, and validate configuration.json. It also addresses gateway retry handling, response helpers, PSP integration checks, and vtex link debugging.

For card authorization, it uses SecureExternalClient with the secureProxyUrl supplied by Create Payment. Later actions such as capture, cancellation, and refund should call the PSP directly through ExternalClient, credentials, and outbound-access policies. The skill also covers IOContext access and checkout testing through affiliations and workspaces.

Builder Hub compiles with TypeScript 3.9.7 and still type-checks dependency declarations when skipLibCheck is set. Newer TypeScript syntax or incompatible .d.ts packages can therefore break the build before the connector code is checked.

What it helps with

  • design a VTEX IO payment connector
  • wire PaymentProviderService and PPP routes
  • validate configuration.json and the paymentProvider builder
  • route authorization through Secure Proxy
  • diagnose TypeScript 3.9.7 dependency failures

Example prompts for the agent

  • Design a VTEX IO payment connector with PaymentProvider and PaymentProviderService.
  • Review configuration.json and manifest.json for a connector that uses Secure Proxy.
  • Investigate a VTEX IO build failure caused by TypeScript 3.9.7 or a dependency declaration.

How to install payment-provider-framework

1Skills CLI (Vercel)

npx skills add vtex/skills --skill payment-provider-framework -a claude-code

2Manually: put the files in place

~/.claude/skills/payment-provider-framework/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/payment-provider-framework/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about payment-provider-framework

How do I install payment-provider-framework in Claude Code?

Run npx skills add vtex/skills --skill payment-provider-framework -a claude-code. The installed skill is then available at ~/.claude/skills/payment-provider-framework/SKILL.md.

What does payment-provider-framework do?

It supports VTEX IO payment connector work, including PPF setup, provider classes, service routes, configuration, PSP clients, Secure Proxy, and checkout testing.

What does the TypeScript 3.9.7 constraint change?

Builder Hub uses TypeScript 3.9.7 and checks declaration files from dependencies even when skipLibCheck is enabled. Syntax from newer TypeScript releases can make the build fail.

Similar skills

All skills for Backend and APIs →

From the same set38

marketplace-fulfillment Helps an agent build the seller side of VTEX fulfillment: simulation, order reservations, dispatch, and invoice and tracking calls to OMS. CX Codex +1 1,000installs marketplace-order-hook Guides VTEX order integrations built with Feed v3 or Hook. Use it when a webhook must validate events, fetch order data, and avoid duplicate processing. CX Codex +1 1,000installs marketplace-catalog-sync Guides the agent while you build a seller connector that pushes SKUs into a VTEX marketplace and keeps price and stock in step. CX Codex +1 1,000installs payment-provider-protocol Assists with building and debugging VTEX Payment Provider Protocol connectors. Enforces endpoint routing, payload schemas, and response rules for homologation. CX Codex +1 1,000installs marketplace-rate-limiting Teaches your agent to handle VTEX API 429s: exponential backoff with jitter, rate limit headers, circuit breaker and request queuing. CX Codex +1 1,000installs payment-async-flow Rules for VTEX payment connector code: Boleto, Pix, bank redirects, callbackUrl handling and signature validation. CX Codex +1 1,000installs payment-pci-security Enforces PCI DSS requirements and Secure Proxy routing when building payment connectors that handle card authorization, token exchange, and post-auth requests. CX Codex +1 1,000installs vtex-io-rbac Walks you through locking down VTEX IO app routes and resources: role policies, resource policies, VRN principals and @auth directives. CX Codex +1 737installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor