README.md

cfPlaid

Integrate with the Plaid API from CFML.

Features

• Basic Account requests
• More coming soon!

Setup

1. Install this module in your app - box install cfPlaid
2. Add the required configuration either via environment variables OR module settings

Configuration

There are two ways to configure API credentials for cfPlaid:

1. Using a .env file
2. Using Module Settings

Env File and commandbox-dotenv

# Plaid API creds
PLAID_URL=https://sandbox.plaid.com

# Plaid keys
PLAID_CLIENT_ID=123_FIXME
PLAID_CLIENT_SECRET=456_FIXME

Module Settings

Add the following to config/ColdBox.cfc and update as necessary:

moduleSettings = {
    cfPlaid = {
        api_url          : "https://sandbox.plaid.com",
        api_client_id    : "123_FIXME",
        api_client_secret: "456_FIXME"
    }
}

API Docs

The cfPlaid class documentation is auto-generated via DocBox and hosted on Github Pages at michaelborn.github.io/cfPlaid/