Plaid.Income (plaid v2.5.0) View Source

Functions for Plaid income endpoint.

Link to this section Summary

config()

params()

t()

Gets Income data associated with an Access Token.

config() :: %{required(atom()) => String.t()}

params() :: %{access_token: String.t()}

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

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

Gets Income data associated with an Access Token.

Parameters

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