paymob

Paymob Integration Skill for AI Agents

Claude.ai / ChatGPT / Lovable skill upload: Download paymob-integration.zip — do not use GitHub's Code → Download ZIP.

Give any AI coding agent expert, workflow-driven knowledge of the Paymob payment gateway across Egypt, UAE, KSA, and Oman. The agent routes the developer by platform, walks through onboarding, and produces correct, copy-ready code for accepting cards, mobile wallets, BNPLs, Apple Pay, Google Pay, Samsung Pay, kiosk, and bank installments — on any tech stack. It also asks the questions merchants forget to: whether the money recurs, gets taken on a phone call, or waits until the order ships.

Ships as a native Codex/ChatGPT plugin, a Claude Code/Cowork plugin, a tested Lovable workspace skill, a standard skill folder for Replit GitHub import, and a portable prompt (universal-prompt.md) + AGENTS.md for Cursor, Windsurf, GitHub Copilot, Gemini, and other agents. Replit guidance is checked against official documentation; a successful Replit import and payment flow must be verified in the user's project.

Where it's listed. Published on the Cursor Directory. Not yet listed in Anthropic's plugin directory, OpenAI's, or Lovable's marketplace, and the Paymob MCP server is not yet in a vendor connector registry — so if you search one of those for "Paymob" and find nothing, that's expected rather than a mistake on your end. No listing is required either way: every method below installs straight from this repo (or its release ZIP), and the Claude Code path registers this repo as a custom marketplace.

Works with any AI agent

It's all plain Markdown — any AI assistant can use it. Find your tool below; most setups take a single step.

Using an “Upload skill” screen? Do not upload GitHub's full repository ZIP. Build or download the dedicated paymob-integration.zip described under Skill upload; it contains one top-level skill folder and leaves every plugin/editor entry point unchanged.

1. Agents with skill-install support → ask them to install the skill

For agents that support fetching and installing skills, paste this:

Install the Paymob integration skill from https://github.com/PaymobAccept/Paymob-AI-Integration-Skill/tree/main/skills/paymob-integration

Install behavior depends on the host. The documented standalone install locations are:

Keep the /tree/main/skills/paymob-integration part of the URL. The repository root is a multi-agent plugin package, not a standalone skill directory — an agent pointed at the bare root can install the wrong tree.

Verify the installation. Ask the agent to read the installed SKILL.md and one task-specific reference. Reload/start a fresh session if that host requires it. Replit's GitHub import is described below; merely pasting a URL into chat does not prove the skill was installed or loaded.

Two things this path deliberately does not do:

• It doesn't register the Paymob MCP server or install Claude slash commands. The selected folder contains only the skill and its references/metadata; the repository-root commands and MCP configuration are separate. Use the full Claude plugin for those, or configure optional MCP separately per Live access. MCP is not required to implement the app's checkout backend.
• It doesn't namespace the skill. Install it this way and as a plugin and you'll have two paymob-integration skills with identical descriptions; disable one to clear the ambiguity.

2. OpenAI Codex → install the standalone skill

Ask Codex:

Use $skill-installer to install https://github.com/PaymobAccept/Paymob-AI-Integration-Skill/tree/main/skills/paymob-integration

Targeting the skills/paymob-integration subdirectory is required; the repository root is a multi-agent plugin package, not a standalone skill directory. The standalone skill includes all references. Add the optional live Paymob server separately with codex mcp add paymob --url https://mcp.paymob.com/mcp.

3. Replit → import the skill from GitHub

1. In Replit Agent, select + → Use a skill → Add from GitHub.
2. Paste https://github.com/PaymobAccept/Paymob-AI-Integration-Skill/tree/main/skills/paymob-integration.
3. Select Preview skills, select paymob-integration, then Import.
4. Select the imported skill and ask Agent to read its SKILL.md, references/replit.md, and the reference matching your backend. A preview only checks structure; verify the agent can actually read the supporting files.

The skill adds guidance; it does not add Paymob to Replit's built-in payment connector catalog or connect MCP. If the payment picker offers Stripe/Whop, ask Agent to inspect whether a custom external API integration is permitted rather than assuming a missing catalog entry prohibits it. Respect an enforced host restriction and preserve the user's provider choice.

See Replit setup and troubleshooting for project-level installation, Secrets, callback URLs, and a verification prompt. This route is documentation-verified, not an end-to-end Replit payment certification.

4. Lovable → import the tested workspace skill

Tested successfully with Lovable Workspace Skills.

1. Download paymob-integration.zip. Keep the file zipped.
2. In your Lovable workspace, open Settings → Skills.
3. Click Import, choose the ZIP tab, and upload paymob-integration.zip.
4. Open Paymob Integration and leave Automatic use enabled, or invoke it explicitly from chat with /paymob-integration.
5. The skill is shared with every project in the workspace. To disable it for one project only, use Project settings → Skills.

You need a workspace owner, admin, or editor role to import a custom skill. Although Lovable also supports public GitHub imports, use the release ZIP for this repository: Lovable accepts SKILL.md only at the repository root or inside one wrapping folder, while this multi-agent plugin intentionally keeps it at skills/paymob-integration/SKILL.md.

5. Cursor → install from the Cursor Directory

Listed at cursor.directory/plugins/paymob-integration. Open the listing and use Add to Cursor on the component you want:

The commands read the skill's reference files at run time, so install the Skill component alongside them — on its own, a command will correctly refuse to answer rather than guess at a field order it cannot read.

6. Coding agents → drop in AGENTS.md

AGENTS.md is an open standard that coding agents read automatically from your project's root folder. Natively supported by OpenAI Codex, Cursor, GitHub Copilot, Windsurf, Gemini CLI, Aider, Zed, Jules, Devin, Factory, Amp, RooCode, Warp, JetBrains Junie, and more.

First inspect any existing project rules. If the project has no AGENTS.md, download this repo's entrypoint into the project root:

# run this from your project's root folder
test ! -e AGENTS.md && curl -fL https://raw.githubusercontent.com/PaymobAccept/Paymob-AI-Integration-Skill/main/AGENTS.md -o AGENTS.md

• Already have an AGENTS.md? Merge the relevant Paymob routing/rules into it under a ## Paymob heading; never overwrite the project's own instructions. In Replit, preserve the project-root replit.md too.
• Now ask your agent in plain English — "Add Paymob card payments to my checkout" — and it follows the Paymob rules automatically.

7. Chat assistants (ChatGPT · Gemini · Claude.ai · Copilot Chat …) → use universal-prompt.md

1. Open universal-prompt.md and copy the whole file.
2. Provide it as project context or an attached instruction file. Use a system/custom-instruction field only if its size limit accepts the whole file; do not truncate payment or security rules to fit.
3. Describe what you're building. It's fully self-contained — no other files needed.

8. Prefer a pinned editor rules file? (optional)

If you'd rather use your editor's native rules file instead of AGENTS.md, save universal-prompt.md as:

9. Claude Code / Cowork → install the full plugin

Pick this over item 1 when you want the bundled live Paymob MCP server (see below) and namespaced plugin commands. Add this repository as a marketplace, then install the plugin:

claude plugin marketplace add PaymobAccept/Paymob-AI-Integration-Skill
claude plugin install paymob-integration@paymob

A shell claude plugin install doesn't take effect in a session that's already running — run /reload-plugins in that session, or restart, before the skill and its commands appear.

Cowork and local-development options are under Installation.

One source of truth, no drift: the full skill lives in skills/paymob-integration/; universal-prompt.md is its self-contained portable copy; AGENTS.md is a short router to it.

What it does

When you ask the agent for help integrating Paymob, it provides:

• Platform routing first — detects Shopify, an official e-commerce plugin platform (WooCommerce, Magento, Odoo, OpenCart, PrestaShop, …), or a custom build, and steers you to the fastest correct path instead of hand-coding when a prebuilt integration already exists.
• Guided onboarding — merchant-status check, dashboard credential collection, and sandbox-first testing before go-live.
• Guided test payments — the agent stops to offer a test payment, shows only the sandbox details for the methods you enabled, and explains how to test your integration type (custom web, Pixel, mobile, Shopify test mode, plugin Test Mode, Payment Links).
• Public webhook URL help — explains why localhost never receives callbacks and offers hooks.paymob.com to inspect callbacks live, or a tunnel/deployed URL to test your handler.