Start in sandbox
Create a first v2 transaction with the minimum setup, then expand into production-safe flows.
Use with AI agents
Give Claude Code, Cursor, Codex, Copilot, Windsurf, Lovable, Bolt.new, or v0 the right Pagou context.
Core integration paths
Payments
Model customers, transactions, Pix, cards, refunds, and transaction status handling.
Payment Element
Mount hosted card fields, trigger tokenization, handle 3D Secure, and keep secrets on your backend.
Pix Out
Create outbound Pix transfers, cancel pending transfers, and reconcile payout state.
Build by job
Accept Pix
Create Pix transactions, return QR code data to the buyer, and finalize from webhook or reconciliation state.
Accept cards
Use
elements.submit(...) to tokenize cards and pass the token to your backend transaction create route.Receive webhooks
Build one ingestion path for payment and payout events with event ID deduplication.
Go live
Confirm environment, auth, idempotency, webhook, retry, and reconciliation behavior before production.
Reference and tools
API Reference
Browse v2 customers, transactions, transfers, and legacy v1 endpoints by resource.
TypeScript SDK
Configure the official server-side TypeScript SDK for payments and transfers.
OpenAPI v2
Use the schema source of truth for request builders, tests, mocks, and agent validation.
Production rules
- Create payments and transfers only from your backend.
- Use
external_refas your stable write identifier. - Never invent fields that are not present in the OpenAPI schema.
- Use Payment Element and
elements.submit(...)for card tokenization. - Fulfill orders only from webhook-confirmed or reconciled state.
- Deduplicate webhooks by the top-level event
id.

