Pluggy API Reference

Pluggy's main API to review data and execute connectors

Version 1.0.0

The Pluggy API is organised around REST: predictable resource URLs, JSON request and response bodies, and standard HTTP verbs and status codes.

Every request carries an X-API-KEY header. There are two credentials: an API key, created on your server and valid for 2 hours, and a Connect Token, issued for one Item and valid for 30 minutes, which is safe to hand to a client.

Sandbox connectors answer like a real institution without touching one, so an integration can be built and tested end to end before the first real connection.

Authentication Conventions and pagination

Getting started

Base URL

https://api.pluggy.ai

Client libraries

Node.jspluggy-sdk
.NETPluggy.SDK
Javaai.pluggy:pluggy-java

The other languages in each endpoint's panel call the API over plain HTTP.

Install and usage

General resources

StatusPublic health and incident data for Pluggy connectors, products and infrastructure. No authentication required.3

GET/api/statusRetrieve status snapshot GET/api/connectors-incidentsRetrieve active incidents by connector GET/api/summaryRetrieve status summary

AuthAuthentication endpoints for API key generation and connect tokens2

POST/authCreate API Key POST/connect_tokenCreate Connect Token

WebhookWebhook configuration and management5

GET/webhooksList POST/webhooksCreate GET/webhooks/{id}Retrieve PATCH/webhooks/{id}Update DELETE/webhooks/{id}Delete

Consents

ItemsItem management for syncing financial data8

POST/itemsCreate GET/items/{id}Retrieve PATCH/items/{id}Update DELETE/items/{id}Delete GET/items/{id}/resourcesRetrieve Item resources POST/items/{id}/mfaSend MFA PATCH/items/{id}/disable-auto-syncDisable item auto sync GET/v2/itemsList

ConnectorFinancial institution connector management3

GET/connectorsList GET/connectors/{id}Retrieve POST/connectors/{id}/validateValidate

Financial data

AccountBank account information and management4

GET/accountsList GET/accounts/{id}Retrieve GET/accounts/{id}/statementsList account statements GET/accounts/{id}/balanceGet real-time balance

TransactionFinancial transaction data and operations4

GET/transactionsList by Page (deprecated)GET/v2/transactionsList GET/transactions/{id}Retrieve PATCH/transactions/{id}Update

CategoryTransaction categorization and rules5

GET/categoriesList GET/categories/{id}Retrieve GET/categories/rulesList Category Rules POST/categories/rulesCreate Category Rule DELETE/categories/rules/{id}Delete Category Rule

InvestmentInvestment portfolio and asset management3

GET/investmentsList GET/investments/{id}Retrieve GET/investments/{id}/transactionsList investment transactions

IdentityUser identity verification and data2

GET/identityFind by item GET/identity/{id}Retrieve

LoanLoan information and management2

GET/loansList GET/loans/{id}Retrieve

BillCredit card bill information2

GET/billsList GET/bills/{id}Retrieve

SCRBacen's credit information system, consulted through a connected Open Finance item1

GET/items/{id}/scrRetrieve SCR

MerchantMerchant and company information by CNPJ1

GET/merchantsGet merchants by CNPJ list

Payments

Payment CustomerPayment customer management5

GET/payments/customersList POST/payments/customersCreate GET/payments/customers/{id}Retrieve PATCH/payments/customers/{id}Update DELETE/payments/customers/{id}Delete

Payment RecipientPayment recipient management7

GET/payments/recipientsList POST/payments/recipientsCreate GET/payments/recipients/{id}Retrieve PATCH/payments/recipients/{id}Update DELETE/payments/recipients/{id}Delete GET/payments/recipients/institutionsList Institutions GET/payments/recipients/institutions/{id}Retrieve Institution

Payment RequestPayment request creation and management6

GET/payments/requestsList POST/payments/requestsCreate POST/payments/requests/pix-qrCreate PIX QR payment request GET/payments/requests/{id}Retrieve PATCH/payments/requests/{id}Update DELETE/payments/requests/{id}Delete

Automatic PIXAutomatic PIX payment scheduling and management7

POST/payments/requests/automatic-pixCreate Automatic PIX payment request POST/payments/requests/{id}/automatic-pix/scheduleSchedule Automatic PIX payment GET/payments/requests/{id}/automatic-pix/schedulesList Automatic PIX scheduled payments GET/payments/requests/{requestId}/automatic-pix/schedules/{paymentId}Get an automatic PIX scheduled payment POST/payments/requests/{id}/automatic-pix/cancelCancel an automatic PIX consent POST/payments/requests/{id}/automatic-pix/schedules/{scheduleId}/cancelCancel an Automatic PIX schedule POST/payments/requests/{id}/automatic-pix/schedules/{scheduleId}/retryRetry an Automatic PIX schedule

Payment SchedulePayment scheduling operations3

GET/payments/requests/{id}/schedulesList Schedules POST/payments/requests/{id}/schedules/cancelCancel Payment Schedule Authorization POST/payments/requests/{id}/schedules/{scheduleId}/cancelCancel Payment Schedule

Payment IntentPayment intent processing3

GET/payments/intentsList POST/payments/intentsCreate GET/payments/intents/{id}Retrieve

Payments · Smart Transfers

Smart TransferSmart transfer functionality6

GET/smart-transfers/preauthorizationsList preauthorizations POST/smart-transfers/preauthorizationsCreate preauthorization GET/smart-transfers/preauthorizations/{id}Retrieve preauthorization GET/smart-transfers/preauthorizations/{id}/paymentsList preauthorization payments POST/smart-transfers/paymentsCreate payment GET/smart-transfers/payments/{id}Retrieve payment

Payments · Direct API

Boleto ManagementBoleto payment management5

POST/boleto-connectionsConnect boleto credentials POST/boleto-connections/from-itemCreate boleto connection from Item POST/boletosIssue Boleto POST/boletos/{id}/cancelCancel Boleto GET/boletos/{id}Get Boleto

Intelligence

EnrichmentTransaction categorization, behavior analysis and recurring-payment detection. Documented on docs.pluggy.ai/reference until the v2 migration; served from enrichment-api.pluggy.ai with its own credentials.3

POST/categorizeCategorize POST/behavior-analysisBehavior Analysis POST/recurring-paymentsRecurring Payments