LLMs

Firma Pay documentation is optimized for AI coding agents. Use the machine-readable index to discover all pages before diving into implementation details.

llms.txt

Fetch the complete documentation index at /llms.txt. This file follows the llms.txt convention — a concise, link-rich overview for LLM crawlers.

curl
curl https://pay.firma.cash/llms.txt

Integration prompt

Paste this into your AI coding agent to scaffold a Firma Pay checkout:

Prompt
Integrate @firma/pay into my app.

Stack: Next.js 15 + TypeScript
Surface: web checkout page
Use case: eComm checkout

Steps:
1. Install: pnpm add @firma/pay
2. Import '@firma/pay/firma-pay.css' and { PayWithFirma } from '@firma/pay'
3. Render PayWithFirma with receiverUsername, orderId, amount, currency
4. Handle onPaymentFinalized(txid) to fulfill the order
5. For Next.js App Router: export const dynamic = 'force-dynamic'

Example:
<PayWithFirma
  receiverUsername="merchant"
  orderId="VP9G"
  amount="10.00"
  currency="USD"
  onPaymentFinalized={(txid) => console.log('Paid!', txid)}
/>

Docs index: https://pay.firma.cash/llms.txt
Quick start: https://pay.firma.cash/docs/quick-start
API reference: https://pay.firma.cash/docs/api-reference

Documentation pages