Skip to main content
The Payluk API skill is an open-source Agent Skill that packages this documentation in the shape AI coding agents read best: the rules every request must follow, the flow to pick for each use case, every endpoint with its customer-id requirement, webhook verification, and the full OpenAPI spec. Install it once and your agent stops guessing header names, fee maths and state transitions.

jerozeek/payluk-api-skill

Source, releases and issues for the skill. MIT licensed.

​
What the agent learns

Agents load the short SKILL.md first and open the detailed references only when a task needs them, so the skill costs little context while still carrying the whole API.

​
Install

Installs the skill for every supported agent detected on your machine, including Claude Code, Cursor, Codex, GitHub Copilot, Gemini CLI and Windsurf.
Add -g to install globally instead of into the current project.

​
Use it

The agent activates the skill on its own whenever a task mentions Payluk, escrows or this API. Prompts that work well:
  • “Add a Payluk standard escrow flow to this Express app: create the escrow for the seller, let the buyer pay from their wallet, and confirm delivery.”
  • “Write a webhook handler for Payluk that verifies the signature and marks the order paid on escrow.completed.”
  • “Why does POST /v1/payment/escrow return Amount mismatch?”
  • “Create a milestone escrow with three milestones and confirm the first one.”
You can also call the API from a terminal with the bundled client. It picks staging or production from your key prefix and prints the standard envelope:
The skill never needs your secret key to be installed. Only the optional CLI reads PAYLUK_SECRET_KEY from your environment, and only at the moment you run it. Keep sk_live_ keys out of prompts, chat logs and committed files. See Authentication.

​
Keep it current

The skill ships a copy of the same openapi.json that renders this API reference, and its endpoint catalog is generated from it. Each API change is released as a new version of the skill, noted in the changelog. Re-run the install command to update. Found a gap or a mistake? Open an issue or a pull request on GitHub.