plaid v1.9.1 Plaid.Income View Source

Functions for Plaid income endpoint.

Link to this section Summary

Functions

Gets Income data associated with an Access Token.

Link to this section Types

Link to this type

config()

View Source
config() :: %{required(atom()) => String.t()}
Link to this type

params()

View Source
params() :: %{access_token: String.t()}
Link to this type

t()

View Source
t() :: %Plaid.Income{
  income: Plaid.Income.Income.t(),
  item: Plaid.Item.t(),
  request_id: String.t()
}

Link to this section Functions

Link to this function

get(params, config \\ %{})

View Source
get(params(), config() | nil) :: {:ok, t()} | {:error, Plaid.Error.t()}

Gets Income data associated with an Access Token.

Parameters

%{
  access_token: "access-env-identifier"
}