View Source Plaid.Income (plaid v3.2.0)

Functions for Plaid income endpoint.

Link to this section Summary

Functions

Gets Income data associated with an Access Token.

Link to this section Types

@type config() :: %{required(atom()) => String.t() | keyword()}
@type error() :: {:error, Plaid.Error.t() | any()} | no_return()
@type params() :: %{required(atom()) => term()}
@type 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
@spec get(params(), config()) :: {:ok, t()} | error()

Gets Income data associated with an Access Token.

Parameters

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