payment-provider-protocol — Claude Code skill: how to install
Assists with building and debugging VTEX Payment Provider Protocol connectors. Enforces endpoint routing, payload schemas, and response rules for homologation.
npx skills add vtex/skills --skill payment-provider-protocol -a claude-codeWhat payment-provider-protocol does
This skill guides the agent when assembling payment middleware for the VTEX Gateway. It enforces all six mandatory endpoints: the manifest, payment creation, cancellation, settlement, refunds, and inbound actions. Three onboarding endpoints for authentication remain optional.
All traffic must go through port 443 over HTTPS with TLS 1.2. VTEX expects responses under 5 seconds during test homologation, while production allows up to 20 seconds. Omitting fields like delayToAutoSettle or authorizationId causes deserialization failures in the gateway.
The gateway initiates all requests directly. For credit card processing, the service requires PCI-DSS compliance or the VTEX Secure Proxy. Concerns like idempotency and async webhooks are handled by separate skills.
What it helps with
- implement mandatory VTEX PPP payment endpoints
- pass VTEX Payment Provider homologation test suite
- format
CreatePaymentresponses with required delay fields - declare supported payment methods inside the manifest router
Example prompts for the agent
- Generate an Express router implementing all six required VTEX PPP endpoints
- Check our
/paymentsresponse handler against VTEX payload requirements - Draft a GET
/manifestendpoint declaring split payment support
How to install payment-provider-protocol
1Skills CLI (Vercel)
npx skills add vtex/skills --skill payment-provider-protocol -a claude-code2Manually: put the files in place
~/.claude/skills/payment-provider-protocol/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/payment-provider-protocol/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill payment-provider-protocol -a codex2Manually: put the files in place
.agents/skills/payment-provider-protocol/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill payment-provider-protocol -a cursor2Manually: put the files in place
.cursor/skills/payment-provider-protocol/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install vtex/skills payment-provider-protocol2Manually: put the files in place
.github/skills/payment-provider-protocol/SKILL.md1Skills CLI (Vercel)
npx skills add vtex/skills --skill payment-provider-protocol -a gemini-cli2Platform CLI
gemini skills install https://github.com/vtex/skills --path skills/payment-provider-protocolManually: put the files in place
.devin/skills/payment-provider-protocol/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add vtex/skills --skill payment-provider-protocol -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about payment-provider-protocol
How to install payment-provider-protocol in Claude Code?
Run npx skills add vtex/skills --skill payment-provider-protocol -a claude-code. The rule file will be added to ~/.claude/skills/payment-provider-protocol/SKILL.md.
What does payment-provider-protocol do?
It provides schemas and routing rules for all mandatory VTEX payment endpoints and verifies required response properties.
Does this skill cover payment idempotency?
No, idempotency and duplicate request tracking belong to the separate payment-idempotency skill.