Skip to main content
HelloPay ships an Agent Skill — a packaged set of instructions, references, and a ready-to-use client that teaches AI coding agents (Claude Code, Cursor, Codex, and others) how to integrate the HelloPay API correctly. Once installed, your agent knows how to create payins and payouts, generate payment links, choose between PSE and BRE-B, poll async transactions, and wire up webhooks — without you pasting docs into every prompt. The skill follows the open Agent Skills standard (a SKILL.md file plus on-demand references/ and assets/) and lives in this repository under skills/hellopay-payments.
The skill is for AI coding agents that help you build your integration. It is not an SDK you import at runtime — but it does ship a copy-paste TypeScript client (assets/hellopay-client.ts) your agent can drop into your backend.

Compatible agents

The skill works with any tool that supports the Agent Skills standard, including Claude Code, Cursor, Codex, Cline, Windsurf, GitHub Copilot, and others. Installation is handled by the skills CLI, which auto-detects the agents you have installed.

Install from this repo

The fastest way is the skills CLI (no global install needed — npx runs it on demand). Point it at this repository and pick the hellopay-payments skill.
1

See what's available (optional)

List the skills published in this repo before installing:
npx skills add hellopay-tech/hellopay-docs-mintlify --list
2

Install the skill

Install hellopay-payments into the agents the CLI detects:
npx skills add hellopay-tech/hellopay-docs-mintlify --skill hellopay-payments
Or target the skill directly by its path in the repo:
npx skills add https://github.com/hellopay-tech/hellopay-docs-mintlify/tree/main/skills/hellopay-payments
3

Start integrating

Open your AI agent and ask it to build with HelloPay — for example, “Create a PSE payin with the HelloPay skill.” The skill activates automatically based on the request. See Using the skill.

Choose scope and target agent

# Installs into the current project, e.g. ./.claude/skills/
npx skills add hellopay-tech/hellopay-docs-mintlify --skill hellopay-payments
Add -y to skip confirmation prompts, and --copy to copy the files instead of symlinking them (useful if you want to pin a version that won’t change when you run update).

Try it without installing

Use the skill for a single session without writing it into your project:
npx skills use https://github.com/hellopay-tech/hellopay-docs-mintlify/tree/main/skills/hellopay-payments

Manual install

If you’d rather not use the CLI, copy the folder into your agent’s skills directory. For Claude Code:
# Project scope
mkdir -p .claude/skills
cp -r path/to/hellopay-docs-mintlify/skills/hellopay-payments .claude/skills/

# Or global scope
cp -r path/to/hellopay-docs-mintlify/skills/hellopay-payments ~/.claude/skills/
The skill is self-contained — keep the SKILL.md, references/, and assets/ together in the hellopay-payments/ folder.

Using the skill

After installing, the skill activates automatically when you ask your agent to do something HelloPay-related, because its description advertises the relevant keywords (payins, payouts, PSE, BRE-B, payment links, webhooks, sandbox). You can also invoke it explicitly by name. Example prompts:
  • “Create a BRE-B payout to @someKey for 10,000 COP using the HelloPay skill.”
  • “Add a /payment-links checkout to my Express app and handle the paymentlink.completed webhook.”
  • “Wire HelloPay webhooks with an idempotent handler and verify the auth header.”
  • “Generate a HelloPay client and poll a PSE payin until pseUrl is ready.”
The agent loads the full instructions on activation and pulls in individual reference files (e.g. the PSE bank-code table) only when a task needs them, so it stays accurate without flooding the context.
Always have your agent build and test against the sandbox first, and use an API key stored server-side.

What’s included

FilePurpose
SKILL.mdAuth, environments, core concepts, quickstarts, and the endpoint catalog
references/payins.mdPSE and BRE-B payin flows, polling, and response shapes
references/payouts.mdBRE-B and Transfiya payout flows and key validation
references/payment-links.mdHosted checkout and payment-link webhooks
references/webhooks.mdEvent payloads, retry rules, and a sample handler
references/sandbox.mdSandbox outcomes, timing, and a test plan
references/api-catalog.mdEvery endpoint, pagination, and conventions
references/pse-banks.mdFull PSE bank-code table
assets/hellopay-client.tsMinimal, dependency-free TypeScript client

Keep it updated

# Update to the latest version published in this repo
npx skills update hellopay-payments

# List installed skills
npx skills list

# Remove it
npx skills remove hellopay-payments