docs: add AGENTS.md, business integration guide, and CLAUDE.md stub#24
Merged
Conversation
Add docs/INTEGRATION.md as a self-contained business integration guide (receive, send, webhooks, sandbox, production checklist), AGENTS.md as the canonical agent/contributor guide with corrected API facts (serviceApiKey, transactions.send), and CLAUDE.md importing AGENTS.md. Link both from the root README.
wthrajat
approved these changes
Jul 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/INTEGRATION.md— self-contained business integration guide: client setup, environments/wallets, receiving (invoice minting + webhook-driven fulfillment), sending (live + sandboxamb_sandbox_behavior), raw-body webhook verification for Express/NestJS/Web-standard runtimes, full typed event shape, error handling, and a production checklist. Can be handed as-is to a team or an AI coding agent.AGENTS.md— canonical agent/contributor guide with facts corrected against the source:serviceApiKey(x-api-key) vsapiKey(Bearer),transactions.sendin the resource table (the previous doc claimed receive-only), codegen, constraints, release process, and a docs-to-keep-in-sync rule.CLAUDE.md— now just@AGENTS.md, so all agents share one source of truth.README.md— Docs section linking both.Test plan
pnpm buildpassespnpm testpasses (29/29)pnpm format:checkpassespackages/payments/src(client config, resources, webhook types)