Pluggy API Reference

Pluggy's main API to review data and execute connectors

Versão 1.0.0

A API da Pluggy é organizada em torno de REST: URLs de recurso previsíveis, corpos de requisição e resposta em JSON, e verbos e códigos de status HTTP padrão.

Toda requisição leva um cabeçalho X-API-KEY. São duas credenciais: uma API key, criada no seu servidor e válida por 2 horas, e um Connect Token, emitido para um único Item e válido por 30 minutos, seguro para entregar a um cliente.

Os conectores de Sandbox respondem como uma instituição real sem tocar em nenhuma, então a integração pode ser construída e testada de ponta a ponta antes da primeira conexão real.

Autenticação Convenções e paginação

Primeiros passos

URL base

https://api.pluggy.ai

Bibliotecas cliente

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

As outras linguagens do painel de cada endpoint chamam a API por HTTP puro.

Instalação e uso

Recursos gerais

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

AuthEndpoints de autenticação para geração de chave de API e Connect Tokens2

POST/authCriar Chave da API POST/connect_tokenCriar Connect Token

WebhookConfiguração e gerenciamento de Webhook5

GET/webhooksLista POST/webhooksCriar GET/webhooks/{id}Recuperar PATCH/webhooks/{id}Atualizar DELETE/webhooks/{id}Excluir

Consentimentos

ItemsGestão de items para sincronizar dados financeiros8

POST/itemsCriar GET/items/{id}Consultar PATCH/items/{id}Atualizar DELETE/items/{id}Excluir GET/items/{id}/resourcesRetrieve Item resources POST/items/{id}/mfaEnviar MFA PATCH/items/{id}/disable-auto-syncDesativar a sincronização automática do item GET/v2/itemsListar

ConnectorGerenciamento de conectores de instituições financeiras3

GET/connectorsLista GET/connectors/{id}Recuperar POST/connectors/{id}/validateValidar

Dados financeiros

AccountInformações e gerenciamento de conta bancária4

GET/accountsLista GET/accounts/{id}Recuperar GET/accounts/{id}/statementsListar extratos de conta GET/accounts/{id}/balanceObtenha saldo em tempo real

TransactionDados e operações de transações financeiras4

GET/transactionsListar por Página (obsoleto)GET/v2/transactionsLista GET/transactions/{id}Recuperar PATCH/transactions/{id}Atualizar

CategoryClassificação e regras de transações5

GET/categoriesLista GET/categories/{id}Recuperar GET/categories/rulesRegras da Categoria de Listagem POST/categories/rulesCriar Regra de Categoria DELETE/categories/rules/{id}Excluir Regra de Categoria

InvestmentPortfólio de investimentos e gestão de ativos3

GET/investmentsLista GET/investments/{id}Recuperar GET/investments/{id}/transactionsListar transações de investimento

IdentityVerificação de identidade do usuário e dados2

GET/identityEncontrar por item GET/identity/{id}Recuperar

LoanInformações e gerenciamento de empréstimos2

GET/loansLista GET/loans/{id}Recuperar

BillInformações da fatura do cartão de crédito2

GET/billsLista GET/bills/{id}Recuperar

SCRSistema de informações de crédito do Bacen, consultado através de um item de Open Finance conectado1

GET/items/{id}/scrRecuperar SCR

MerchantInformações do comerciante e da empresa pelo CNPJ1

GET/merchantsObter comerciantes pela lista de CNPJ

Pagamentos

Payment CustomerGerenciamento de clientes de pagamento5

GET/payments/customersLista POST/payments/customersCriar GET/payments/customers/{id}Recuperar PATCH/payments/customers/{id}Atualizar DELETE/payments/customers/{id}Excluir

Payment RecipientGerenciamento de destinatários de pagamento7

GET/payments/recipientsLista POST/payments/recipientsCriar GET/payments/recipients/{id}Recuperar PATCH/payments/recipients/{id}Atualizar DELETE/payments/recipients/{id}Excluir GET/payments/recipients/institutionsListar Instituições GET/payments/recipients/institutions/{id}Recuperar Instituição

Payment RequestCriação e gerenciamento de solicitações de pagamento6

GET/payments/requestsLista POST/payments/requestsCriar POST/payments/requests/pix-qrCriar solicitação de pagamento via QR PIX GET/payments/requests/{id}Recuperar PATCH/payments/requests/{id}Atualizar DELETE/payments/requests/{id}Excluir

Automatic PIXAgendamento e gerenciamento automático de pagamentos PIX7

POST/payments/requests/automatic-pixCriar solicitação de pagamento PIX automático POST/payments/requests/{id}/automatic-pix/scheduleAgendar pagamento automático via PIX GET/payments/requests/{id}/automatic-pix/schedulesListar pagamentos automáticos de PIX agendados GET/payments/requests/{requestId}/automatic-pix/schedules/{paymentId}Obtenha um pagamento PIX agendado automaticamente POST/payments/requests/{id}/automatic-pix/cancelCancelar um consentimento automático de PIX POST/payments/requests/{id}/automatic-pix/schedules/{scheduleId}/cancelCancelar um agendamento automático de PIX POST/payments/requests/{id}/automatic-pix/schedules/{scheduleId}/retryTentar novamente um agendamento automático de PIX

Payment ScheduleOperações de agendamento de pagamento3

GET/payments/requests/{id}/schedulesListar Agendas POST/payments/requests/{id}/schedules/cancelCancelar Autorização de Agendamento de Pagamento POST/payments/requests/{id}/schedules/{scheduleId}/cancelCancelar Agendamento de Pagamento

Payment IntentProcessamento de intenção de pagamento3

GET/payments/intentsLista POST/payments/intentsCriar GET/payments/intents/{id}Recuperar

Pagamentos · Smart Transfers

Smart TransferFuncionalidade de transferências inteligentes6

GET/smart-transfers/preauthorizationsListar pré-autorizizações POST/smart-transfers/preauthorizationsCriar pré-autorização GET/smart-transfers/preauthorizations/{id}Recuperar pré-autorização GET/smart-transfers/preauthorizations/{id}/paymentsListar pagamentos de pré-autorização POST/smart-transfers/paymentsCriar pagamento GET/smart-transfers/payments/{id}Recuperar pagamento

Pagamentos · API Direta

Boleto ManagementGerenciamento de pagamento por Boleto5

POST/boleto-connectionsConectar credenciais de boleto POST/boleto-connections/from-itemCriar conexão de boleto a partir do Item POST/boletosEmitir Boleto POST/boletos/{id}/cancelCancelar Boleto GET/boletos/{id}Obter Boleto

Inteligência

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