PluggyElixir

Welcome to Pluggy Elixir, an API client written in Elixir to access the Open Finance services provided by Pluggy

Installation

Add pluggy_elixir to your list of dependencies in mix.exs:

def deps do
  [
    {:pluggy_elixir, "~> 0.0.1"}
  ]
end

Update deps

mix deps.get

Add the credentials to your config file (ex: config.exs)

config :pluggy_elixir,
  client_id: "your-app-client-id",
  client_secret: "your-app-client-secret",

See more about configurations in PluggyElixir.Config docs.

Use cases

Register

Data	Use Cases
{ full_name, tax_id, date_of_bird, address, phone_numbers }	Onboarding Registration KYC Customer segmentation

Checking account

Data	Use Cases
{ balances, transactions: [ { date, values, description, type, category } ] }	Income analysis Consumption profile Financial management Risk modeling Financial monitoring Investment capacity

Credit card

Data	Use Cases
{ limits, minimum_payment, brand, segment, maturity, transactions }	Consumption profile Financial management Credit taking capacity Financial monitoring Expenses by category Consumption cycles Recurring expenses

Investments

Data	Use Cases
{ assets, code, type, quantity, value, historical_profitability, taxes, index, balance_at_the_broker, handling_at_the_broker }	Portfolio Consolidation Financial Profile Transaction monitoring Investment capacity analysis Portfolio risk analysis Investment automation

Plugged Institutions

Banks	Investment brokers
Itaú (Personal e Corporate) Bradesco (Personal e Corporate) Nubank (Personal) Santander (Personal e Corporate) Banco do Brasil (Personal e Corporate) Caixa (Personal e Corporate) Inter (Personal e Corporate) Modal Mais (Personal) BTG Pactual (Personal) Mercado Pago (Personal)	XP Investimentos Rico Easynvest Órama Genial Agora

API spec

For most up-to-date and accurate documentation, please see the API Spec page.

Contributing

Contributing Guide

License

Apache License, Version 2.0 © Finbits