Plaid.Income (plaid v3.0.0) 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

Specs

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

Specs

error() :: {:error, Plaid.Error.t() | any()} | no_return()

Specs

params() :: %{required(atom()) => term()}

Specs

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

Specs

get(params(), config()) :: {:ok, t()} | error()

Gets Income data associated with an Access Token.

Parameters

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