investec-private-banking

n8n node to call the Investec Private Banking API

Package Information

Downloads: 2 weekly / 11 monthly
Latest Version: 1.0.0
Author: Vincent Chegwidden

Documentation

Banner image

n8n-investec-private banking

This is an n8n community node. It lets you interact with your Investec Private banking account via their Programmable Banking API

To learn more about Investec Programmable banking visit https://developer.investec.com/za/home

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources
Version history
Development
Running Locally
Contributing
License

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

Auth Actions

  1. Get access token

Accounts Actions

  1. List all accounts
  2. Get account balance
  3. Get account transactions
  4. Get account pending transactions

Profile Actions

  1. List all profiles consented to
  2. List all profile accounts
  3. List authorisation setup details
  4. List all available beneficiaries

Transfer Actions

  1. Inter account transfers

Document Actions

  1. List all documents
  2. Retreive document

Beneficiary Actions

  1. List of beneficiaries
  2. List of beneficiary categories
  3. Pay multiple beneficiaries

Credentials

The API uses OAuth2 for authentication and all operations require Bearer token authentication. To assist with this there is a Investec Private Banking Auth node.

To use the node, add it to your workflow and setup a new credential.
alt text

Enter your Client ID, Client Secret and API key obtained from the Investec Portal
alt text

NOTE: Nodes do not refresh an expired token. You will need to do this manually in your workflows

Compatibility

Developed and tested using n8n version 1.111.0

Usage

alt text

Basic requirements for using the nodes is that you need to first get an access token using the Auth node. After that the token can be passed to the other nodes to execute different operations

alt text

Resources

Version history

v.1.0.0: First release includes all the operations avaialable on the API

Development

You need the following installed on your development machine:

  • git
  • Node.js and npm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL here. For Windows users, refer to Microsoft's guide to Install NodeJS on Windows.
  • Install n8n with:
    npm install n8n -g
    
  • Recommended: follow n8n's guide to set up your development environment.

Running locally

First install all the requirement for local development.

To build run

npm run build
npm link

Then to test locally

cd ~/.n8n/custom
npm link n8n-nodes-investec-private-banking
n8n start

Contributing

  • 🐛 Report Bugs: Open an issue with detailed bug reports
  • 💡 Feature Requests: Suggest new features or improvements
  • 📝 Documentation: Help improve our docs and code comments
  • 🔧 Code Contributions: Submit pull requests for bug fixes or features

TODO

License

MIT

🌟 Star History

Star History Chart


If you find this project helpful, please give it a ⭐️!

Discussion