# Pluggy Docs

> Developer documentation for the Pluggy API

## integrations

- [Slack Integration](https://docs.pluggy.dev/docs/integrations/slack): Add Pluggy's hosted docs bot to your Slack workspace — ask questions and get answers from the live documentation. No setup, no self-hosting.
- [Discord Integration](https://docs.pluggy.dev/docs/integrations/discord): A hosted Pluggy docs bot for Discord is coming soon. In the meantime, use the Slack bot, the MCP server, or the docs site.

## Getting Started

- [Overview](https://docs.pluggy.dev/docs/overview): Learn what Pluggy is and how it can help you build financial applications.
- [Quick Start](https://docs.pluggy.dev/docs/quickstart): Get up and running with Pluggy in minutes.
- [Authentication](https://docs.pluggy.dev/docs/authentication): Learn how to authenticate with the Pluggy API.
- [Glossary](https://docs.pluggy.dev/docs/get-started/glossary): Before you start working with our API there are some important concepts that you need to know.

## Guides

- [Sandbox](https://docs.pluggy.dev/docs/guides/sandbox): Test your integration with Pluggy's sandbox environment.

## Pluggy Connect Widget

- [Introduction](https://docs.pluggy.dev/docs/connect-widget/introduction): Pluggy Connect is a drop-in widget that helps you quickly get started with Pluggy, allowing your users to connect their accounts within your app directly to the Pluggy API.
- [Authentication](https://docs.pluggy.dev/docs/connect-widget/authentication): When connecting to Pluggy from a client-side application (i.e. Connect Widget), a Connect Token is required. This token provides limited access scoped to the generated Item resource data.
- [Environments and Configurations](https://docs.pluggy.dev/docs/connect-widget/environments): Learn about the available environments and configuration options for the Pluggy Connect widget, including sandbox testing and production setup.
- [Updating an Item](https://docs.pluggy.dev/docs/connect-widget/updating-item): Learn how to update an existing Item using the Pluggy Connect widget instead of creating a new connection from scratch.
- [Customization](https://docs.pluggy.dev/docs/connect-widget/customization): From the Dashboard, it is possible to customize certain visual aspects of Pluggy Connect so that you can provide your users with a more tailored, branded experience.
- [OAuth Support Guide](https://docs.pluggy.dev/docs/connect-widget/oauth-support): By following these guidelines, you can ensure a smooth OAuth integration experience for your users across various platforms and devices.

## Connections

- [Item](https://docs.pluggy.dev/docs/connections/item): An Item is the representation of a connection with a specific Connector of an Institution and serves as the entry point to access the set of products recovered from the user who gave consent to collect their data.
- [Item lifecycle](https://docs.pluggy.dev/docs/connections/item-lifecycle): Understand the different statuses and execution states an Item goes through during creation, update, and synchronization with financial institutions.
- [Errors & Validations](https://docs.pluggy.dev/docs/connections/errors-validations): Learn about the different statuses and errors you could face using Pluggy's API.
- [Warnings & Status Codes](https://docs.pluggy.dev/docs/connections/warnings-status-codes): Understanding warning codes and their meanings when retrieving data from Pluggy connectors.
- [Consents and expiration](https://docs.pluggy.dev/docs/connections/consents): The first time an Item connects, a Consent is created with an expiration date. The Consent shows which financial products an item is authorized to recover for a given period.
- [Connectors coverage](https://docs.pluggy.dev/docs/connections/connectors-coverage): Here you will find all the connectors available in Pluggy listed by type of connector, detailing which products are supported in each case.
- [Credit Cards coverage](https://docs.pluggy.dev/docs/connections/credit-cards-coverage): Here you will find the coverage we have for each connector regarding Credit Card product.
- [Accounts coverage](https://docs.pluggy.dev/docs/connections/accounts-coverage): Here you will find the coverage we have for each connector regarding Account product.
- [Payment data coverage](https://docs.pluggy.dev/docs/connections/paymentdata-coverage): Here you will find the data coverage we have for each connector regarding Payment Data product.
- [Investments coverage](https://docs.pluggy.dev/docs/connections/investments-coverage): Here you will find the coverage we have for each connector regarding Investments product.
- [Investment Transactions coverage](https://docs.pluggy.dev/docs/connections/investment-transactions-coverage): Here you will find the coverage we have for each connector regarding Investment Transactions product.
- [Loans coverage](https://docs.pluggy.dev/docs/connections/loans-coverage): Here you will find the coverage we have for each connector regarding the Loans product.
- [Identity coverage](https://docs.pluggy.dev/docs/connections/identity-coverage): Here you will find the coverage we have for each connector regarding Identity product.
- [Reporting Issues](https://docs.pluggy.dev/docs/connections/reporting-issues): This guide explains how to understand issues that users may have and how to report them to Pluggy's support team.

## Open Finance

- [Open Finance Connectors](https://docs.pluggy.dev/docs/open-finance/overview): Pluggy supports obtaining data from the Brazilian Open Finance Network with Open Finance Connectors, following the same data model as standard connectors.
- [Open Finance Institutions Coverage](https://docs.pluggy.dev/docs/open-finance/institutions-coverage): All institutions available via Open Finance, their contexts (Personal, Business, Investments) and the products each connector exposes.
- [Creating an Item](https://docs.pluggy.dev/docs/open-finance/creating-item): How to create your first Open Finance Regulated connection, step by step through Pluggy's Connect Widget or through API.
- [Considerations & FAQ](https://docs.pluggy.dev/docs/open-finance/considerations-faq): Things to keep in mind when integrating Open Finance Regulated data that can be different from Direct Connections.
- [Payment Data Open Finance Coverage](https://docs.pluggy.dev/docs/open-finance/payment-data): Coverage details for CPF/CNPJ counterpart data availability in Open Finance transaction payment data, by connector and operation type.
- [Investments Open Finance Coverage](https://docs.pluggy.dev/docs/open-finance/investments): Coverage table for investment subtypes supported by each Open Finance institution connector.
- [Operational Rate Limits](https://docs.pluggy.dev/docs/open-finance/rate-limits): Open Finance rate limits imposed by the Brazilian Open Finance Network on data fetching per product, institution, and CPF/CNPJ.

## Products

- [Account](https://docs.pluggy.dev/docs/products/accounts): The account product is the list of bank accounts such as Checking or Savings Account and Credit Card, that were available in the selected connector.
- [Real Time Balance](https://docs.pluggy.dev/docs/products/real-time-balance): The real-time balance endpoint fetches the account balance directly from the financial institution without triggering a full item sync.
- [Credit Card Bills](https://docs.pluggy.dev/docs/products/credit-card-bills): The Bill entity is recovered from institutions that support this product. It represents a bill (fatura) associated with an account of type Credit, specifically the subtype CREDIT_CARD.
- [Transaction](https://docs.pluggy.dev/docs/products/transactions): Retrieve up to 12 months of transaction data. Transactions data of the accounts provide insights into the user's financial behavior.
- [Transaction Categorization](https://docs.pluggy.dev/docs/products/transaction-categorization): Transaction categorization is a feature where we classify your Transactions into useful categories (Restaurants, Gas Stations, Income, etc.) using our categorizer AI engine.
- [Investment](https://docs.pluggy.dev/docs/products/investments): The Investment entity is recovered from not only Brokers (XP, Clear) but also from retail and business Bank institutions.
- [Investment's Transactions](https://docs.pluggy.dev/docs/products/investment-transactions): Each investment contains a list of transactions corresponding to Applications or Withdrawals. The transaction schema contains a set of details of that operation.
- [Loan](https://docs.pluggy.dev/docs/products/loans): The Loan entity is recovered from institutions that support this product. It represents a loan contracted by the user, including data like contract number, taxes, interest rates, warranties, installments, etc.
- [Identity](https://docs.pluggy.dev/docs/products/identity): The Identity entity is recovered from institutions that support this product, accessing details of personal information related to the owner of the connection's account.
- [Credit Card Installments](https://docs.pluggy.dev/docs/products/credit-card-installments): How Pluggy captures, synchronizes, and delivers credit card installment purchases via API, including institution-specific behaviors, Open Finance rate limits, and webhook best practices.

## Intelligence APIs

- [Connection Insights](https://docs.pluggy.dev/docs/intelligence/connection-insights): Based on connected accounts you can recover user's insights, book of variables, income analysis & recurring patterns.
- [Transaction Enrichment](https://docs.pluggy.dev/docs/intelligence/transaction-enrichment): If you need to enhance your own data, we offer different solutions engine as an API for you to use.
- [Recurring Payments Analysis](https://docs.pluggy.dev/docs/intelligence/recurring-payments): We offer a Recurring Payments API that allows you to identify a user's repeating expenses and repeating incomes, useful for financial profiling.

## Payments

- [Payments Overview](https://docs.pluggy.dev/docs/payments/overview): With Pluggy Payments, you can easily create payment links to bill your customers and automatically track their payments, leveraging secure OAuth integrations with institutions using the Open Finance Payment Initiation infrastructure.
- [Payment Intent Lifecycle and Errors](https://docs.pluggy.dev/docs/payments/intent-lifecycle): Here you can find the possible statuses of a Payment Intent and the error codes that may occur when attempting to process a payment.
- [Scheduled Payments (Pix Agendado)](https://docs.pluggy.dev/docs/payments/scheduled-payments): With our payment initiation functionality, you can schedule payments to occur in the future (also called PIX RECORRENTE) using different scheduling modes.
- [Scheduled Payment Webhooks](https://docs.pluggy.dev/docs/payments/scheduled-webhooks): Learn about the webhook flow and payloads for scheduled payments, including error codes that may occur during payment processing.
- [FAQ](https://docs.pluggy.dev/docs/payments/scheduled-faq): The purpose of this page is to answer common questions about Scheduled Payments.
- [PIX Automatico](https://docs.pluggy.dev/docs/payments/pix-automatico): Introduction to Pix Automático with Pluggy - your gateway to seamless, automated recurring payments in Brazil.
- [Getting Started](https://docs.pluggy.dev/docs/payments/pix-getting-started): Integrating with Pluggy's payment gateway for Pix Automático - learn how to create your first payment request, handle authorization, schedule payments, and manage retries.
- [Automatic PIX Scheduler (Beta)](https://docs.pluggy.dev/docs/payments/pix-scheduler): The Automatic PIX Scheduler automates recurring payment scheduling without manual intervention, respecting the allowed D+2 to D+10 scheduling window.
- [Automatic retries (Beta)](https://docs.pluggy.dev/docs/payments/pix-retries): When an Automatic Pix Payment fails, Pluggy can automatically handle retries for you - no extra API calls, no polling, no cron jobs on your side.
- [FAQ](https://docs.pluggy.dev/docs/payments/pix-faq): Common questions related to how Pix Automatico works, including payment requests, first payments, scheduling, cancellation, and retries.
- [Coverage](https://docs.pluggy.dev/docs/payments/coverage): Here you will understand how to keep track of which Institutions support each type of payment.

## Smart Transfers

- [Introduction](https://docs.pluggy.dev/docs/smart-transfers/introduction): Pluggy's Smart Transfers API makes payments instant, easy, and secure. Here we describe in a simple way how you can implement it.
- [Creating a preauthorization](https://docs.pluggy.dev/docs/smart-transfers/preauthorization): In this section, you will learn how to create a preauthorization to do payments without user interaction.
- [Creating a payment](https://docs.pluggy.dev/docs/smart-transfers/creating-payment): In this section, you will learn how to create a payment associated with a Smart Transfer Preauthorization.
- [Smart Transfers Sandbox](https://docs.pluggy.dev/docs/smart-transfers/sandbox): The easiest way to try the Smart Transfers product is by using the sandbox connector.

## Developer Tools

- [Basic concepts](https://docs.pluggy.dev/docs/developer-tools/basic-concepts): Learn about the security protocols, API conventions, environment, and pagination used by the Pluggy API.
- [Run in Postman](https://docs.pluggy.dev/docs/developer-tools/postman): Access Pluggy's Postman Collection to test all available API endpoints using your CLIENT_ID and CLIENT_SECRET.
- [Connect an account](https://docs.pluggy.dev/docs/developer-tools/connect-account): Learn how to connect the Pluggy API with a financial institution, including connectors with and without verification codes.
- [Tutorials](https://docs.pluggy.dev/docs/developer-tools/tutorials): Get step-by-step guides on how to successfully connect your account with specific financial institutions.
- [Server-Side SDKs](https://docs.pluggy.dev/docs/developer-tools/server-sdks): Pluggy offers client libraries for Node.js, .NET, and Java to simplify API integration.
- [No-Code integrations](https://docs.pluggy.dev/docs/developer-tools/no-code): Here is a list of integrations that don't require any development to start running Pluggy.
- [Bubble](https://docs.pluggy.dev/docs/developer-tools/bubble): Step-by-step guide to integrating Pluggy Connect in a Bubble application.
- [Errors Codes](https://docs.pluggy.dev/docs/developer-tools/error-codes): The following errors describe in general what you will get for the different endpoints available in Pluggy API.
- [Rate limits](https://docs.pluggy.dev/docs/developer-tools/rate-limits): Pluggy's API implements a rate limiter to maximize its stability when dealing with large bursts of incoming requests.
- [Status Page API](https://docs.pluggy.dev/docs/developer-tools/status-page-api): Programmatically consume Pluggy's public status page — connector health, incidents and infrastructure components.
- [Webhook](https://docs.pluggy.dev/docs/developer-tools/webhooks-ref): Learn about the webhooks sent by Pluggy to create a reactive integration to data and payment changes.
- [Configure & Troubleshoot](https://docs.pluggy.dev/docs/developer-tools/webhook-troubleshoot): View, create and edit webhooks from Dashboard, visualize which webhooks were sent, their payloads and retry them to sync collected data.
- [MCP Server](https://docs.pluggy.dev/docs/developer-tools/mcp): Connect any AI agent — Claude, ChatGPT/Codex, Cursor, VS Code, Windsurf, Gemini — to Pluggy's live documentation, API reference, changelog, recipes, and curated Q&A through the hosted, no-auth MCP server.
- [Agent Skills](https://docs.pluggy.dev/docs/developer-tools/ai-skills): Official Pluggy skills for AI coding agents like Claude Code, Cursor, and GitHub Copilot — install with one command so your agent builds and reviews integrations following Pluggy's documented patterns.

## Integration Checklist

- [Creating a use case from scratch](https://docs.pluggy.dev/docs/integration-checklist/use-case): This article is a step by step guide to build a simple example app that integrates with Pluggy.
- [Pluggy's Integration Checklist](https://docs.pluggy.dev/docs/integration-checklist/overview): Follow these steps to ensure your Application is fully integrated with Pluggy API.
- [Get your API keys](https://docs.pluggy.dev/docs/integration-checklist/api-keys): Get to know Dashboard. Create your first Application and obtain your access keys.
- [Create your first Item](https://docs.pluggy.dev/docs/integration-checklist/first-item): Get to know our Demo application. Get to know Pluggy Connect and our Sandbox environment.
- [Use our SDKs to Authenticate](https://docs.pluggy.dev/docs/integration-checklist/sdk-auth): Using your Application CLIENT_ID and CLIENT_SECRET credentials, set up authentication with Pluggy API.
- [Setup PluggyConnect Widget on your app](https://docs.pluggy.dev/docs/integration-checklist/setup-widget): The Connect Widget is Pluggy's plug and play frontend solution that allows users to connect their financial accounts on a step by step flow.
- [Data sync: Update an Item](https://docs.pluggy.dev/docs/integration-checklist/data-sync): After creating an Item, the next step is keeping it up to date.
- [Setup Two-way sync with Webhooks](https://docs.pluggy.dev/docs/integration-checklist/webhooks-sync): Webhooks allow Pluggy to notify your application of events without requiring you to request updates, keeping you up to date with the latest changes.
- [Consent management: Delete an Item](https://docs.pluggy.dev/docs/integration-checklist/consent-management): It's of utmost importance for your integration to allow your users to revoke the consent given when sharing their financial data.
- [Subscribe to our Status Page](https://docs.pluggy.dev/docs/integration-checklist/status-page): Check out our public status page where we post any incident and outages, so you can keep awareness on any existing issues.

## Boleto

- [Boleto Management API](https://docs.pluggy.dev/docs/boleto/management-api): With our Boleto Management API, you can quickly create a Boleto and receive payment notifications for it, allowing you to automate your entire billing process.

## Tutorials

- [Caixa PF Tutorial (Mobile)](https://docs.pluggy.dev/docs/developer-tools/tutorials/caixa-pf-mobile): Step-by-step guide to authorize your device and connect a Caixa Econômica Federal personal account using the Caixa mobile app.
- [Caixa PF Tutorial (Web)](https://docs.pluggy.dev/docs/developer-tools/tutorials/caixa-pf-web): Step-by-step guide to authorize your device and connect a Caixa Econômica Federal personal account using Internet Banking on the web.
- [Caixa PJ Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/caixa-pj): Which credentials to use when connecting a Caixa Empresas business account: the same username and password used in Internet Banking.
- [Banco Inter MEI Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/inter-mei): How to connect a Banco Inter MEI account by logging into the Inter app with your MEI account number and scanning the access QR code.
- [Banco Inter Empresas Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/inter-pj): How to create an API integration in Banco Inter Empresas to obtain the Client ID, Client Secret, key, and certificate needed to connect with Pluggy.
- [Sicredi Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/sicredi): Which credentials to use when connecting a Sicredi Empresas account: CNPJ, username, and password — the same ones used in the Sicredi app.
- [Sicoob PJ Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/sicoob-pj): Which credentials to use when connecting a Sicoob Empresas account: cooperative number, access key, and password from Internet Banking.
- [Santander PJ Secondary User Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/santander-pj-secondary-user): Step-by-step guide to create a secondary user in Santander Empresas so you can connect your business account with Pluggy.
- [Santander PJ Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/santander-pj): Which credentials to use when connecting a Santander Empresas business account: branch, account, username and password — the same used in Internet Banking.
- [Itaú PJ Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/itau-pj): Which credentials to use when connecting an Itaú Empresas business account: branch, account, password and CPF — the same used in Internet Banking.
- [Itaú PJ Tutorial — User Without a Token](https://docs.pluggy.dev/docs/developer-tools/tutorials/itau-pj-user-without-token): How to create an operator user without a token in Itaú Empresas: create an access profile, add an operator and validate it via the web.
- [Banco do Brasil PJ Tutorial — Device Authorization](https://docs.pluggy.dev/docs/developer-tools/tutorials/bb-pj-device-authorization): How to authorize a device in Banco do Brasil's Internet Banking so you can connect your Banco do Brasil Empresas account.
- [Banco do Brasil PJ Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/bb-pj): Which credentials to use when connecting a Banco do Brasil Empresas business account: J key, J password and 8-digit password — plus best practices for a successful connection.
- [Bradesco PJ Tutorial — Enable Mobile App Access](https://docs.pluggy.dev/docs/developer-tools/tutorials/bradesco-pj-mobile-access): How to enable mobile app access for a Bradesco Empresas user through the Internet Banking administration section.
- [Bradesco PJ Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/bradesco-pj): Which credentials to use when connecting a Bradesco Empresas business account: username, password and the security key generated in the Bradesco app.
- [Bradesco PF Open Finance Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/bradesco-pf-of): Step-by-step guide to connect a Bradesco personal (PF) account via Open Finance, using the QR code validation in the Bradesco app.
- [Efí Bank PJ Tutorial](https://docs.pluggy.dev/docs/developer-tools/tutorials/efi-pj): How to create an API application in Efí Bank Empresas to obtain the Client ID, Client Secret and certificate needed to connect with Pluggy.