PluggyAI

An idiomatic Elixir client for the Pluggy open-finance API.

Why?

Pluggy is an open-finance data aggregation platform for the Brazilian market. It lets you connect to banks and financial institutions to retrieve accounts, transactions, investments, loans, and identity data through a single API.

This library wraps the Pluggy REST API idiomatically with some nice friendly user interface, such as the usual :ok, :error tuple syntax and their equivalent ! methods that raise if the operation is not successful, formatting the responses into maps with snake_case atom keys, pagination unwrappers, and a lot more!

In Pluggy's API, you'll need an item, which is a representation of a connection to one of the service's many Connectors. according to [Pluggy's own documentation] (https://docs.pluggy.ai/docs/item#creating-an-item-institution-authentication-flow), the best way to do so is to use their provided widget. This library provides a nice wrapper of this widget as both a Phoenix.Component, and a Kino.JS.Live, and those modules will only be compiled if the dependencies are found in your project, so there won't be any unnecessary bloat in your application!

Warning: The Phoenix.Component is still under development, so it's API is prone to some changes!

Installation

Add pluggy_ai to your dependencies:

def deps do
  [
    {:pluggy_ai, github: "fellipessanha/pluggy_ai_ex"}
  ]
end

Optional dependencies

As stated above, there's wrappers for the connection widget in popular Elixir Frameworks. These are the ones currently available

Getting credentials

The best way to test this library -- or to use this for personal finance data, is to use Meu Pluggy. Read the docs to see what's good about it!

1. Create an account at pluggy.ai
2. Grab your Client ID and Client Secret from the Pluggy dashboard

Quick start

See our Livebook example to get a feeling of what's it like to use this library!

Session API

Pluggy.Session provides a stateless convenience wrapper that groups a client, connect token, and connected item into a single struct:

{:ok, client} = Pluggy.Client.new("client_id", "client_secret")
session = Pluggy.Session.new(client)

{:ok, token, session} = Pluggy.Session.connect_token(session)
# ... user completes Connect flow, returns item_data ...
session = Pluggy.Session.with_item(session, item_data)

{:ok, accounts} = Pluggy.Session.accounts(session)
{:ok, transactions} = Pluggy.Session.transactions(session, account_id)

API modules

License

MIT — see LICENSE.txt.