# Pagou Developer Docs

> Integrate payments, payouts, webhooks, and frontend card flows with Pagou.ai API.

## Docs

- [Create a Customer](https://developer.pagou.ai/api-reference/customers/create.md): Create a reusable buyer profile.
- [Get a Customer](https://developer.pagou.ai/api-reference/customers/get.md): Retrieve a reusable buyer profile by ID.
- [List Customers](https://developer.pagou.ai/api-reference/customers/list.md): List reusable buyer profiles.
- [Customers Reference](https://developer.pagou.ai/api-reference/customers/reference.md): API operations for creating and retrieving reusable buyer profiles.
- [Create a PIX Payment](https://developer.pagou.ai/api-reference/legacy-v1/create-pix-payment.md): Create a PIX payment through the legacy v1 API.
- [Create a Webhook Integration](https://developer.pagou.ai/api-reference/legacy-v1/create-webhook-integration.md): Configure webhook integration for a legacy v1 account.
- [Get Account Balance](https://developer.pagou.ai/api-reference/legacy-v1/get-account-balance.md): Retrieve the account balance for a legacy v1 integration.
- [Get a PIX Transaction](https://developer.pagou.ai/api-reference/legacy-v1/get-pix-transaction.md): Retrieve a PIX transaction by ID for a legacy v1 integration.
- [List PIX Transactions](https://developer.pagou.ai/api-reference/legacy-v1/list-pix-transactions.md): List PIX transactions for a legacy v1 integration.
- [Legacy v1 Reference](https://developer.pagou.ai/api-reference/legacy-v1/reference.md): Legacy API operations for existing v1 integrations.
- [Refund a PIX Payment](https://developer.pagou.ai/api-reference/legacy-v1/refund-pix-payment.md): Refund a PIX payment through the legacy v1 API.
- [Validate Authentication](https://developer.pagou.ai/api-reference/legacy-v1/validate-authentication.md): Validate legacy v1 API authentication.
- [Withdraw a PIX Payment](https://developer.pagou.ai/api-reference/legacy-v1/withdraw-pix-payment.md): Create a PIX withdrawal through the legacy v1 API.
- [Create a Transaction](https://developer.pagou.ai/api-reference/transactions/create.md): Create a Pix or card transaction.
- [Get a Transaction](https://developer.pagou.ai/api-reference/transactions/get.md): Retrieve a transaction by ID.
- [List Transactions](https://developer.pagou.ai/api-reference/transactions/list.md): List transactions for reconciliation and operations.
- [Transactions Reference](https://developer.pagou.ai/api-reference/transactions/reference.md): API operations for creating, reading, updating, and refunding v2 transactions.
- [Refund a Transaction](https://developer.pagou.ai/api-reference/transactions/refund.md): Refund an eligible transaction.
- [Update a Transaction](https://developer.pagou.ai/api-reference/transactions/update.md): Update a transaction in the test environment.
- [Cancel a Transfer](https://developer.pagou.ai/api-reference/transfers/cancel.md): Cancel a pending Pix Out transfer.
- [Create a Transfer](https://developer.pagou.ai/api-reference/transfers/create.md): Create a Pix Out transfer.
- [Get a Transfer](https://developer.pagou.ai/api-reference/transfers/get.md): Retrieve a Pix Out transfer by ID.
- [List Transfers](https://developer.pagou.ai/api-reference/transfers/list.md): List Pix Out transfers for payout reconciliation.
- [Transfers Reference](https://developer.pagou.ai/api-reference/transfers/reference.md): API operations for creating, retrieving, listing, and canceling Pix Out transfers.
- [Changelog](https://developer.pagou.ai/changelog/index.md): Track documentation and public platform changes relevant to Pagou integrations.
- [Accept a Payment](https://developer.pagou.ai/frontend/payment-element/accept-a-payment.md): Build a production-safe Payment Element checkout from card input through backend creation, 3DS, and final order state handling.
- [Appearance and Events](https://developer.pagou.ai/frontend/payment-element/appearance-and-events.md): Customize the Payment Element card field and react to its lifecycle with supported browser events.
- [Migration from WebSDK](https://developer.pagou.ai/frontend/payment-element/migration-from-websdk.md): Move from the legacy WebSDK card flow to Payment Element with low operational risk and a stable backend contract.
- [Overview](https://developer.pagou.ai/frontend/payment-element/overview.md): Understand what Payment Element is, when to use it, and how it fits into Pagou's card payment lifecycle.
- [Quickstart](https://developer.pagou.ai/frontend/payment-element/quickstart.md): Mount the Payment Element, tokenize card details, and create a card payment through your backend in the shortest possible path.
- [Testing and Troubleshooting](https://developer.pagou.ai/frontend/payment-element/testing-and-troubleshooting.md): Validate Payment Element in sandbox, test 3DS paths, and diagnose the most common integration mistakes.
- [3D Secure](https://developer.pagou.ai/frontend/payment-element/three-d-secure.md): Handle automatic and manual 3DS flows with Payment Element without breaking checkout, fulfillment, or reconciliation.
- [Pagou Developer Docs](https://developer.pagou.ai/index.md): Integrate Pix, card payments, payouts, webhooks, and frontend card flows with a v2-first developer journey.
- [v1 Account Balance](https://developer.pagou.ai/legacy/v1/account-balance.md): Query account balance for legacy integrations that still depend on the v1 route family.
- [v1 Authentication](https://developer.pagou.ai/legacy/v1/authentication.md): Reference the legacy v1 auth model only if you maintain an existing integration.
- [v1 to v2 Migration](https://developer.pagou.ai/legacy/v1/migration-to-v2.md): Map legacy Pagou route families and operational assumptions to the recommended v2 integration model.
- [v1 Overview](https://developer.pagou.ai/legacy/v1/overview.md): Maintain existing v1 integrations while planning the move to Pagou v2.
- [v1 Pix Payments](https://developer.pagou.ai/legacy/v1/pix-payments.md): Maintain or migrate legacy Pix payment flows exposed through the v1 route family.
- [v1 Webhook Configuration](https://developer.pagou.ai/legacy/v1/webhook-configuration.md): Reference the legacy webhook integration endpoint while moving webhook handling practice to the unified v2 guidance.
- [Card Payments Overview](https://developer.pagou.ai/payments/cards/overview.md): Choose the recommended card integration pattern and understand how Pagou handles tokenization and 3DS.
- [Payment Element for Cards](https://developer.pagou.ai/payments/cards/payment-element.md): Understand why Payment Element is the default card integration and how it connects to the transactions API.
- [Card Refund Behavior](https://developer.pagou.ai/payments/cards/refund-behavior.md): Model card refunds operationally so your product, support, and finance logic stay aligned.
- [Card Transaction Lifecycle](https://developer.pagou.ai/payments/cards/transaction-lifecycle.md): Handle authorization, 3DS, capture outcomes, and terminal states in a predictable card payment flow.
- [Customers](https://developer.pagou.ai/payments/customers.md): Create and retrieve customer records in Pagou v2 when your product needs reusable buyer profiles.
- [Payments Overview](https://developer.pagou.ai/payments/overview.md): Understand how customers, transactions, Pix, cards, webhooks, and refunds fit together in Pagou v2.
- [Accept Pix Payments](https://developer.pagou.ai/payments/pix/accept-payments.md): Create a Pix transaction, return QR code data to the buyer, and operate the flow with webhooks plus reconciliation.
- [Pix Reconciliation](https://developer.pagou.ai/payments/pix/reconciliation.md): Use Pagou read APIs to verify transaction state when a webhook is delayed, missed, or operationally ambiguous.
- [Pix Refunds](https://developer.pagou.ai/payments/pix/refunds.md): Issue full or partial refunds for eligible transactions and align your product and finance state to the resulting statuses.
- [Transaction Statuses](https://developer.pagou.ai/payments/transaction-statuses.md): Use one canonical status map for Pix and card transactions in your product, operations, and webhook handlers.
- [Cancel a Pix Out Transfer](https://developer.pagou.ai/payouts/pix-out/cancel-transfer.md): Cancel a pending transfer safely and avoid duplicate operator actions during payout management.
- [Create a Pix Out Transfer](https://developer.pagou.ai/payouts/pix-out/create-transfer.md): Create a transfer request, persist the Pagou transfer ID, and transition state from webhook delivery.
- [Pix Out Overview](https://developer.pagou.ai/payouts/pix-out/overview.md): Send outbound Pix transfers, track lifecycle changes, and reconcile payout operations safely.
- [Transfer Reconciliation](https://developer.pagou.ai/payouts/pix-out/reconciliation.md): Use Pagou transfer read APIs to recover from delayed events, worker failures, or uncertain payout state.
- [Transfer Statuses](https://developer.pagou.ai/payouts/pix-out/statuses.md): Map Pagou payout statuses into operator workflows, merchant messaging, and reconciliation jobs.
- [Payments with the TypeScript SDK](https://developer.pagou.ai/sdks/typescript/payments.md): Create, list, retrieve, update, refund, and reconcile Pagou transactions with concrete TypeScript SDK examples.
- [TypeScript SDK Quickstart](https://developer.pagou.ai/sdks/typescript/quickstart.md): Use the official TypeScript SDK with real examples for configuration, authentication, request options, retries, and response handling.
- [Transfers with the TypeScript SDK](https://developer.pagou.ai/sdks/typescript/transfers.md): Create, list, retrieve, cancel, and reconcile Pix transfers with concrete TypeScript SDK examples.
- [AI-Assisted Integration](https://developer.pagou.ai/start-here/ai-integration.md): Give AI coding agents the right Pagou docs context before they generate integration code.
- [Authentication](https://developer.pagou.ai/start-here/authentication.md): Authenticate Pagou API requests consistently and choose one production standard for your integration.
- [CLAUDE.md Template](https://developer.pagou.ai/start-here/claude-md-template.md): Copy this CLAUDE.md file to give Claude Code full context for Pagou integrations.
- [.cursorrules Template](https://developer.pagou.ai/start-here/cursorrules-template.md): Copy this .cursorrules file to give Cursor full context for Pagou integrations.
- [Environments](https://developer.pagou.ai/start-here/environments.md): Choose the correct base URL, credentials, and release discipline for sandbox and production.
- [Errors and Retries](https://developer.pagou.ai/start-here/errors-and-retries.md): Interpret Pagou error responses and decide when to retry, fix input, or reconcile state.
- [Go-live Checklist](https://developer.pagou.ai/start-here/go-live-checklist.md): Use this production checklist before you switch a Pagou integration from sandbox to live traffic.
- [Idempotency](https://developer.pagou.ai/start-here/idempotency.md): Prevent duplicate money movement by treating external_ref as your stable write identifier.
- [Overview](https://developer.pagou.ai/start-here/overview.md): Understand the supported public surface of Pagou.ai before you start integrating.
- [Quickstart](https://developer.pagou.ai/start-here/quickstart.md): Create your first successful v2 sandbox transaction with the minimum required setup.
- [Webhook Fundamentals](https://developer.pagou.ai/start-here/webhooks.md): Use webhooks as the primary source of truth for asynchronous payment and payout updates, with polling only as a fallback.
- [Webhooks Overview](https://developer.pagou.ai/webhooks/overview.md): Build one resilient webhook ingestion path for both payment and payout events.
- [Payment Events](https://developer.pagou.ai/webhooks/payment-events.md): Handle transaction webhooks for Pix and card payments using the exact public payload shape Pagou delivers today.
- [Retries and Reconciliation](https://developer.pagou.ai/webhooks/retries-and-reconciliation.md): Recover safely from webhook redelivery, worker failures, or uncertain payment and payout state.
- [Transfer Events](https://developer.pagou.ai/webhooks/transfer-events.md): Handle Pix Out webhook events using the live payout envelope Pagou emits today.

## OpenAPI Specs

- [openapi](https://developer.pagou.ai/api-reference/openapi.json)
- [openapi-v2](https://developer.pagou.ai/api-reference/openapi-v2.json)
- [openapi-v1](https://developer.pagou.ai/api-reference/openapi-v1.json)

## Optional

- [API status](https://status.pagou.ai)
- [GitHub](https://github.com/pagouai)