plaid v0.3.0 Plaid.Categories
Functions for working with Plaid Categories.
- Return all categories
- Fetch a category by id
This endpoint requires no authentication.
Plaid API Reference: https://plaid.com/docs/api/#categories
Summary
Functions
Specs
all :: {atom, list}Returns all Plaid categories.
Returns the universe of Plaid categories in it’s current state. Category taxnomy is updated periodically, so refreshing data cached locally is useful.
Returns a list of Plaid.Categories or Plaid.Error struct.
Example
{:ok, [%Plaid.Categories{...}]} = Plaid.Categories.all()
{:error, %Plaid.Error{...}} = Plaid.Categories.all()Plaid API Reference: https://plaid.com/docs/api/#all-categories
Specs
id(integer | binary) :: {atom, map}Fetches a Plaid category based on the id.
Returns a specific Plaid category by category id provided. This function accepts the id as an integer or string. Useful for returning data about the category based on the id returned in the transactions from the Connect endpoint.
Returns a Plaid.Categories struct.
Example
{:ok, %Plaid.Categories{...}} = Plaid.Categories.id("12015002")
{:error, %Plaid.Error{...}} = Plaid.Categories.id("12015002")Plaid API Reference: https://plaid.com/docs/api/#categories-by-id