Skip to main content
skill CX Codex

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.

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

What 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 CreatePayment responses 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 /payments response handler against VTEX payload requirements
  • Draft a GET /manifest endpoint declaring split payment support

How to install payment-provider-protocol

1Skills CLI (Vercel)

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

2Manually: put the files in place

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

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

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.

Similar skills

All skills for Backend and APIs →

From the same set38

vtex-io-http-routes Guides the design of HTTP endpoints in a VTEX IO backend service: route boundaries, middleware chains, request validation and response shape. CX Codex +1 1,100installs 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 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 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. CX Codex +1 979installs

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