# payment-provider-framework

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.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 979 installs · ★ 46
- Author: vtex
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/vtex/skills/tree/HEAD/skills/payment-provider-framework/SKILL.md
- Updated: 2026-10-14
- HTML: https://affpapa.org/en/nevibecode/skills/payment-provider-framework

## What it 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.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill payment-provider-framework -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/payment-provider-framework/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/payment-provider-framework/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill payment-provider-framework -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/payment-provider-framework/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill payment-provider-framework -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/payment-provider-framework/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install vtex/skills payment-provider-framework
```

2. **Manually: put the files in place**
- File: `.github/skills/payment-provider-framework/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill payment-provider-framework -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/vtex/skills --path skills/payment-provider-framework
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/payment-provider-framework/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add vtex/skills --skill payment-provider-framework -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/vtex/skills/tree/HEAD/skills/payment-provider-framework/SKILL.md

## When to use it
- 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
- 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.

## Similar
- [mcp-builder](https://affpapa.org/en/nevibecode/skills/mcp-builder.md) — skill · 130949 installs
- [claude-api](https://affpapa.org/en/nevibecode/skills/claude-api.md) — skill · 74198 installs
- [lark-im](https://affpapa.org/en/nevibecode/skills/lark-im.md) — skill · 472900 installs
- [lark-event](https://affpapa.org/en/nevibecode/skills/lark-event.md) — skill · 466800 installs
- [caveman-discover](https://affpapa.org/en/nevibecode/skills/caveman-discover.md) — skill · 104400 installs
- [migration](https://affpapa.org/en/nevibecode/skills/migration.md) — skill · 103900 installs

From the same set: [vtex/skills](https://affpapa.org/en/nevibecode/by/vtex/skills.md) — 38 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md