# shopify-payments-apps

Writes GraphQL queries and mutations against the Shopify Payments Apps API. Handy when you work on payment sessions, refunds or captures.

- skill · `type=skill` · Codex, ChatGPT · ★ 7604
- Author: Shopify · official OpenAI repository
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/openai/plugins/tree/HEAD/plugins/shopify/skills/shopify-payments-apps/SKILL.md
- Updated: 2026-10-08
- HTML: https://affpapa.org/en/nevibecode/skills/shopify-payments-apps

## What it does

The skill walks the agent through Payments Apps API work in a fixed order: look up the operation in the docs, write the code from what comes back, then validate it. Searches target an operation or component name rather than the whole task description, so the agent stops leaning on whatever it remembers about the schema.

Two scripts do the work. `scripts/search_docs.mjs` queries the documentation vector store, and `scripts/validate.mjs` checks the generated code. The validator takes flags for model, client and version names, plus `--artifact-id` and `--revision`. When a check fails, the agent searches for the reported error type, fixes it and validates again, up to three attempts.

Node.js is required. Both scripts report to Shopify at `shopify.dev/mcp/usage`: search queries, validation results, skill name, model and client identifiers. Set `OPT_OUT_INSTRUMENTATION=true` to turn that off — otherwise the reporting is on.

## Install

### Codex (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add openai/plugins --skill shopify-payments-apps -a codex
```

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

### Claude Code

1. **Skills CLI (Vercel)**
```bash
npx skills add openai/plugins --skill shopify-payments-apps -a claude-code
```

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

### Cursor

**Manually: put the files in place**
- File: `.cursor/skills/shopify-payments-apps/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install openai/plugins shopify-payments-apps
```

2. **Manually: put the files in place**
- File: `.github/skills/shopify-payments-apps/SKILL.md`

### Gemini CLI

**Platform CLI**
```bash
gemini skills install https://github.com/openai/plugins --path plugins/shopify/skills/shopify-payments-apps
```

### Windsurf (Devin Desktop)

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

### 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/openai/plugins/tree/HEAD/plugins/shopify/skills/shopify-payments-apps/SKILL.md

## When to use it
- write a GraphQL mutation that creates a payment session
- handle authorization, capture and settlement for a payment
- reconcile a refund or void against the original transaction
- add error handling for declined payments and network failures
- wire up 3D Secure and payment confirmation webhooks

## Example prompts
- Write the paymentSessionPending mutation for the Payments Apps API and validate it
- Generate a GraphQL query for a refund on a transaction, search the docs for an example first
- Run my code through `scripts/validate.mjs` and fix whatever the validation reports

## Similar
- [shopify-apps](https://affpapa.org/en/nevibecode/skills/sickn33-shopify-apps.md) — skill · 1000 installs
- [shopify-products](https://affpapa.org/en/nevibecode/skills/shopify-products.md) — skill · 1400 installs
- [shopify-setup](https://affpapa.org/en/nevibecode/skills/shopify-setup.md) — skill · 1200 installs
- [shopify-expert](https://affpapa.org/en/nevibecode/skills/shopify-expert.md) — skill · 5000 installs
- [shopify](https://affpapa.org/en/nevibecode/skills/shopify.md) — skill · 4800 installs
- [shopify-development](https://affpapa.org/en/nevibecode/skills/shopify-development.md) — skill · 1900 installs

From the same set: [openai/plugins](https://affpapa.org/en/nevibecode/by/openai/plugins.md) — 528 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