Pular para as operações

Bancário

Pluggy em um fluxo de decisão.

11 Pluggy operations a decision flow can call directly, with the credentials your own contract issued. The response is data the rest of the flow reads, branches on, and keeps in the trace.

Categoria
Bancário
Tipo
Integração
Autenticação
Troca de tokens
Ambiente de teste
Somente host de produção

Quem são

Open Finance e dados bancários no Brasil.

A Pluggy se conecta aos bancos brasileiros, tanto pelos trilhos regulados do Open Finance quanto por conexões diretas, e devolve contas, transações, investimentos, empréstimos e identidade. Financiadoras a usam para comprovar renda e dívida existente de solicitantes cujo cadastro no bureau diz pouco. Ela também inicia pagamentos por Pix, incluindo o agendado e o automático.

O que um fluxo pode chamar

11 operações, cada uma um passo que você coloca no editor.

  1. POST/connect_token

    Iniciar uma conexão bancária (Connect token)

    Mints the short-lived token that initialises the Pluggy Connect widget in the applicant's browser, so bank credentials never touch us.

  2. POST/items

    Criar uma conexão bancária (Item)

    Cria um item direto, sem o widget, e inicia a primeira sincronização.

  3. GET/items/$data.pluggy_item_id

    Check a connection's state (Item)

    O estado de uma conexão. Leia isso antes de puxar dados — um item em LOGIN_ERROR ou WAITING_USER_INPUT não tem dado fresco atrás dele, e um fluxo que pula a checagem pontua silenciosamente um cadastro velho.

  4. POST/items/$data.pluggy_item_id/mfa

    Answer a bank's second factor (MFA)

    Envia o valor que o banco pediu enquanto o item está em WAITING_USER_INPUT.

  5. GET/accounts?itemId=$data.pluggy_item_id

    Listar contas

    Todas as contas por trás de uma conexão, com o saldo atual e o disponível.

  6. GET/accounts/$data.pluggy_account_id/balance

    Obter o saldo em tempo real

    Lê o saldo direto na instituição, sem uma sincronização completa do item.

  7. GET/v2/transactions?accountId=$data.pluggy_account_id

    Listar transações

    Até doze meses de transações de uma conta, paginadas por cursor.

  8. GET/identity?itemId=$data.pluggy_item_id

    Ler a identidade que o banco tem

    Nome, documento, endereços, telefones e e-mails como a instituição os tem.

  9. GET/loans?itemId=$data.pluggy_item_id

    Listar empréstimos existentes

    Crédito já em aberto na instituição — o lado da dívida na capacidade de pagamento.

  10. GET/bills?accountId=$data.pluggy_account_id

    Listar faturas de cartão de crédito

    Histórico de faturas de uma conta de cartão de crédito: totais, pagamentos mínimos e datas de vencimento.

  11. GET/connectors

    Listar instituições

    Todas as instituições que a Pluggy alcança, com os parâmetros de que cada uma precisa e se é uma conexão regulada de Open Finance ou uma conexão direta.

Onde isso entra na decisão

Banking calls have a natural place in a flow.

O dado bancário responde à pergunta que a renda declarada não responde: o que de fato entra, com que regularidade, e o que sai de novo. Normalmente é puxado uma vez por proposta e depois lido por vários nós — capacidade de pagamento, verificação de renda, qualquer regra sobre volatilidade de saldo — então vale buscá-lo cedo e derivar dele, em vez de chamá-lo repetidas vezes.

Whatever Pluggy returns is part of the run, so it is part of the record. When someone asks months later why an applicant was declined, the answer cites what came back at the time rather than re-fetching from a service whose answer has since changed.

  • 01Add Pluggy as a connection authenticating with a token exchange.
  • 02A Pluggy tem um host só para os dois ambientes, então proteja as execuções de teste com credenciais e limites seus.
  • 03Coloque um nó de Conexão e escolha uma operação — “Iniciar uma conexão bancária (Connect token)” costuma ser a primeira de que um fluxo precisa.
  • 04Mapeie a resposta nos campos que suas regras leem e depois teste o caminho inteiro antes de ele receber tráfego de produção.

Perguntas frequentes

Usando a Pluggy em um fluxo.

Como conecto a Pluggy a um fluxo de decisão?

Adicione a Pluggy como uma conexão no seu workspace, autenticando com uma troca de tokens, com as credenciais que o seu próprio contrato emitiu — a ArboRule chama o provedor no seu lugar e nunca assume um contrato por você. Depois que a conexão existe, qualquer fluxo do workspace pode colocar um nó de Conexão e escolher uma das operações dela. As credenciais ficam na conexão, não no fluxo, então quem cuida da política usa a Pluggy em uma decisão sem nunca ver o segredo.

Dá para testar a Pluggy sem tocar em produção?

A Pluggy expõe um host só para os dois ambientes, então não existe um sandbox separado para apontar. As execuções de teste continuam rodando no Sandbox e ficam registradas à parte no histórico de decisões, mas a chamada vai para o mesmo lugar que a de produção — então proteja isso com credenciais de teste, limites de taxa ou dados seus.

O que um fluxo pode chamar na Pluggy?

11 operations, including “Start a bank connection (Connect token)”, “Create a bank connection (Item)”, “Check a connection's state (Item)”. Each one is a step you place on the canvas and map into the fields your rules read, and most flows start with “Start a bank connection (Connect token)”. The list comes from the same manifest the engine uses to make the call, so this page cannot describe an operation the product does not have.

Em que ponto de uma decisão a Pluggy deve ser chamada?

O dado bancário responde à pergunta que a renda declarada não responde: o que de fato entra, com que regularidade, e o que sai de novo. Normalmente é puxado uma vez por proposta e depois lido por vários nós — capacidade de pagamento, verificação de renda, qualquer regra sobre volatilidade de saldo — então vale buscá-lo cedo e derivar dele, em vez de chamá-lo repetidas vezes.

Also in Banking

Quando você quiser

Wire Pluggy into a real decision.

Monte o fluxo no Sandbox, conecte sua conta e veja a decisão buscar o que precisa antes de responder.

Leia a documentação