https://github.com/finbits/pluggy_elixir

A client library for Pluggy.ai API
https://github.com/finbits/pluggy_elixir

elixir open-banking open-finance pluggy pluggy-sdk

Last synced: 3 days ago
JSON representation

A client library for Pluggy.ai API

• Host: GitHub
• URL: https://github.com/finbits/pluggy_elixir
• Owner: Finbits
• License: apache-2.0
• Archived: true
• Created: 2021-04-24T17:34:23.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-05T18:18:28.000Z (almost 4 years ago)
• Last Synced: 2024-12-22T20:20:48.971Z (10 months ago)
• Topics: elixir, open-banking, open-finance, pluggy, pluggy-sdk
• Language: Elixir
• Homepage:
• Size: 103 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# PluggyElixir

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Finbits/pluggy_elixir/CI?style=flat-square)](https://github.com/Finbits/pluggy_elixir/actions?query=workflow%3ACI)

[![Hex.pm](https://img.shields.io/hexpm/v/pluggy_elixir?style=flat-square)](https://hex.pm/packages/pluggy_elixir)

[![Hex.pm](https://img.shields.io/hexpm/l/pluggy_elixir?style=flat-square)](https://hex.pm/packages/pluggy_elixir)

[![Hex.pm](https://img.shields.io/hexpm/dt/pluggy_elixir?style=flat-square)](https://hex.pm/packages/pluggy_elixir)

[![codecov](https://img.shields.io/codecov/c/github/Finbits/pluggy_elixir?style=flat-square)](https://codecov.io/gh/Finbits/pluggy_elixir)

Welcome to Pluggy Elixir, an API client written in Elixir to access the Open Finance services provided by [Pluggy](http://pluggy.ai)

## Installation

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

```elixir

def deps do

  [

    {:pluggy_elixir, "~> 0.0.1"}

  ]

end

```

Update deps

```sh

mix deps.get

```

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

```elixir

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](https://docs.pluggy.ai) page.

## Contributing

[Contributing Guide](CONTRIBUTING.md)

## License

[Apache License, Version 2.0](LICENSE) © [Finbits](https://github.com/Finbits)