elixir_plaid v1.2.1

View Source Plaid.Liabilities (elixir_plaid v1.2.1)

Plaid Liabilities API calls and schema.

Link to this section Summary

Types

t()

Functions

get(access_token, options \\ %{}, config)

Get liabilities information.

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Plaid.Liabilities{
  credit: [Plaid.Liabilities.Credit.t()],
  mortgage: [Plaid.Liabilities.Mortgage.t()],
  student: [Plaid.Liabilities.Student.t()]
}

Link to this section Functions

Link to this function

get(access_token, options \\ %{}, config)

View Source

Specs

get(String.t(), options, Plaid.config()) ::
  {:ok, Plaid.Liabilities.GetResponse.t()} | {:error, Plaid.Error.t()}
when options: %{optional(:account_ids) => [String.t()]}

Get liabilities information.

Does a POST /liabilities/get call which fetches liabilities associated with an access_token's item.

Params:

  • access_token - Token to fetch liabilities for.

Options:

  • :account_ids - Specific account ids to fetch liabilities for.

examples

 Examples 

Liabilities.get("access-sandbox-123xxx", client_id: "123", secret: "abc")
{:ok, %Liabilities.GetResponse{}}