Pluggy API API Reference

Pluggy's main API to review data and execute connectors

Version 1.0.0

Status

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

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

Auth

Authentication endpoints for API key generation and connect tokens

POST/authCreate API Key POST/connect_tokenCreate Connect Token

Connector

Financial institution connector management

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

Items

Item management for syncing financial data

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

Consent

User consent management for data access

GET/consentsList GET/consents/{id}Retrieve

Account

Bank account information and management

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

Transaction

Financial transaction data and operations

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

Investment

Investment portfolio and asset management

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

Identity

User identity verification and data

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

Webhook

Webhook configuration and management

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

Loan

Loan information and management

GET/loansList GET/loans/{id}Retrieve

Merchant

Merchant and company information by CNPJ

GET/merchantsGet merchants by CNPJ list

Bill

Credit card bill information

GET/billsList GET/bills/{id}Retrieve

Payment Customer

Payment customer management

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

Payment Recipient

Payment recipient management

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 Request

Payment request creation and management

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 PIX

Automatic PIX payment scheduling and management

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 Schedule

Payment scheduling operations

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 Intent

Payment intent processing

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

Smart Transfer

Smart transfer functionality

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

Boleto Management

Boleto payment management

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