/plaid-node

Primary LanguageJavaScriptMIT LicenseMIT

Plaid node.js client

plaid-node is a node.js client for Plaid

Documentation

Documentation is available at https://plaid.com/v2/docs.

Install

npm install plaid

Examples

var plaid = require('plaid')({client_id: '123456', secret: '7891011'});

/**
 * Connect/Add a user.
 */
plaid.connect({username: 'demo', password: 'test'}, 'type', 'test@plaid.com', function(error, response, mfa){
	
	//Non MFA
	console.log(response)

	//MFA
	if (mfa) {
		var answer_question = "this is my answer";
		plaid.step(response.access_token, answer_question, function(err, response){
			//response is accounts and transactions object
		})
	}
});

/**
 * Get a user's transactions, using the access_token
 */
plaid.get(access_token, function(err, res) {
  console.log('Accounts : ', res.accounts);
  console.log('Transactions : ', res.transactions);
});

Test

To run the tests, you need to :

  • Sign up for a key
  • Set the user bank information into process variables The tests work only for a 'bofa' account so far. You'll have to provide the answer to a secret question during the tests to validate the connection to the bank.
export PLAID_CLIENTID=123456
export PLAID_SECRET=7890
export PLAID_USER_USERNAME=username
export PLAID_USER_PASSWORD=pass
export PLAID_USER_TYPE=bofa
export PLAID_USER_EMAIL=test@plaid.com
npm test

License

MIT