Pagar.me is the API-first online payments platform from Stone Co., one of Brazil's largest financial technology companies — often referred to as "the Stripe of Brazil." A single Core API v5 surface (and a fleet of official SDKs) lets Brazilian e-commerce merchants, marketplaces, SaaS companies, and subscription businesses accept credit and debit cards, Pix instant payments, boletos, vouchers, and digital wallets, with built-in 3DS 2.0 anti-fraud, payment splitting and recipient management for marketplaces, recurring billing through plans and subscriptions, anticipation of receivables, payment links, an embedded Checkout, and signed webhooks. Pagar.me is PCI DSS Level 1 certified and powers payments for Brazilian brands including Leroy Merlin, Casa & Vídeo, Polishop, Usaflex, and Catarse.
URL: Visit APIs.json
Run: Capabilities Using Naftiko
- Payments, Financial Services, Fintech, Brazil, Latin America, Stone Co, Pix, Boleto, Credit Card, Marketplace, Split Payments, Subscriptions, Recurring Billing, Anti-Fraud, 3DS, Checkout, Payment Links, Webhooks, E-commerce, Anticipation
- Created: 2026-05-25
- Modified: 2026-05-25
| Surface | What it is |
|---|---|
| Base URL | https://api.pagar.me/core/v5 |
| Current version | Core API v5 (2021-09-01) — legacy v1–v4 still accessible |
| Auth | HTTP Basic with a Pagar.me API key (Access Keys) |
| Docs | docs.pagar.me (guides) + docs.pagar.me/reference (reference) |
| Agent index | docs.pagar.me/llms.txt — Markdown index of every doc page and OpenAPI endpoint |
| SDKs | Node.js / TypeScript, Python, PHP, Ruby, Java, .NET Standard, Go |
| Modules | Magento 2 / Adobe Commerce, WooCommerce, VTEX, Nuvemshop, Shopify |
| Compliance | PCI DSS Level 1; Res. BCB 264 / 349 receivables registry |
| Parent | Stone Co. (NASDAQ: STNE) |
Top-level payment object in Core API v5. Create orders containing one or more charges paid via credit/debit card, Pix, boleto, voucher, Google Pay, or private label card; manage cancellation, capture, refund, items, customers, and split rules for marketplaces.
- Reference — Create order
- Payment methods: credit card, debit card, Pix, boleto, voucher, Google Pay
Manage individual charges (cobranças) — the unit of capture inside an order. Get, edit payment method or saved card, capture pre-authorized amounts, refund all or part of a charge, and track the chargeback lifecycle.
Create and manage end-customer (buyer) records — personal data, CPF/CNPJ, contact info, and addresses — and tie them to orders, subscriptions, and saved cards. Underpins the customer wallet / one-click-buy experience.
Tokenize, save, and edit credit/debit cards inside a Pagar.me customer wallet, off-load PCI scope, and reuse cards for one-click buy and recurring charges. Supports network tokens (token de bandeira) and the Card Updater service.
Define reusable recurring billing plans — pricing, billing cycle, trial period, installment count, accepted payment methods, items — to back subscription products.
Create customer subscriptions from a plan or standalone (avulsa), renew cycles, edit payment method / card / discount / minimum price, change items, and inspect each cycle's invoice and charges. Powers SaaS, streaming, education, and club-of-the-month businesses on Pagar.me.
Onboard and manage recipients (recebedores) — the sub-merchants that receive split payments in a marketplace. Run the KYC / prova de vida flow, attach bank accounts, configure transfer settings, and create KYC links.
Create, cancel, list, and retrieve transfers from a recipient's Pagar.me balance to their registered bank account, plus pull the official transfer receipt (comprovante).
The per-recipient balance ledger — every credit, debit, fee, refund, chargeback, anticipation, transfer, and adjustment that moves money in or out of a Pagar.me account. Canonical source of truth for finance reconciliation.
List future receivables — installments of credit-card sales that will settle over the coming weeks and months. Basis for cash-flow forecasting and anticipation simulation.
Pagar.me's working-capital product — pull future credit-card installments to today's balance for a fee. Spot simulation, limits inspection, create, list, and cancel pending anticipations.
Retrieve settlements (pagamentos) — the actual money movements out of Pagar.me to recipients — individually, in bulk, or by recipient.
List and retrieve disputes (disputas) and chargebacks raised against the merchant's transactions, including the new chargeback-specific charge status.
Generate, list, retrieve, activate, and cancel payment links — short URLs that wrap a Pagar.me Checkout for sale-by-link, WhatsApp commerce, Instagram bio links, and lightweight invoicing.
Contract effects and Unidades de Recebíveis (URs) under the Brazilian Central Bank's Resoluções BCB 264 and 349 receivables-registry regime — list contract effects, contest a contract, list contests, pull URs by recipient.
Subscribe to and receive signed webhook events — order.paid, charge.captured, charge.refunded, subscription.created, recipient.kyc_updated, dispute.opened, and the rest of the catalog.
Pagar.me's drop-in PCI-compliant payment form for one-off orders and subscriptions, with first-class AI/agent integration patterns (Claude Code, Codex, Cursor, Copilot) documented as Checkout Skills.
| Method | Reference |
|---|---|
| Credit card | docs.pagar.me/reference/cartão-de-crédito-1 |
| Debit card | docs.pagar.me/reference/cartão-de-débito-2 |
| Pix | docs.pagar.me/reference/pix-2 · Pix guide · Pix simulator |
| Boleto | docs.pagar.me/reference/boleto-1 |
| Voucher | docs.pagar.me/reference/voucher-1 |
| Google Pay | docs.pagar.me/reference/google-paytm-api · Google Pay guide |
| Private label card | docs.pagar.me/reference/cartão-private-label-2 |
| Language | Repo |
|---|---|
| Node.js / TypeScript | pagarme/pagarme-nodejs-sdk |
| Python | pagarme/pagarme-python-sdk |
| PHP | pagarme/pagarme-php-sdk |
| Ruby | pagarme/pagarme-ruby-sdk |
| Java | pagarme/pagarme-java-sdk |
| .NET Standard | pagarme/pagarme-net-standard-sdk |
| Go | pagarme/pagarme-core-api-go |
- Magento 2 / Adobe Commerce — guide
- WooCommerce — guide
- VTEX — marketplace sellers
- Nuvemshop
- Shopify
- E-commerce Module Core (PHP)
- Pagar.me Portal
- Documentation
- API Reference
- Getting Started with the API
- Access Keys (Auth)
- Rate Limits
- Security & PCI
- IP Allowlist
- 3DS 2.0 Authentication
- Help Center
- Sign In
- Pricing / Offers
- llms.txt (AI agent index)
- GitHub — pagarme
- api-evangelist/anthropic — Claude is one of the AI coding assistants Pagar.me explicitly targets in its Checkout Skills and llms.txt-driven integration patterns for AI-assisted payment integration.