PlaidEx.API.Signal (plaid_ex v1.0.0)

Plaid Signal API — ACH return risk scoring.

Summary

Returns a Decision Report confirming whether the ACH was initiated.

Evaluates ACH return risk for a transaction.

Prepares items for Signal evaluation.

Reports the outcome of an ACH return.

@spec decision_report(PlaidEx.Config.t(), String.t(), boolean(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Returns a Decision Report confirming whether the ACH was initiated.

@spec evaluate(PlaidEx.Config.t(), map(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Evaluates ACH return risk for a transaction.

@spec prepare(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Prepares items for Signal evaluation.

@spec return_report(PlaidEx.Config.t(), String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, PlaidEx.Error.t()}

Reports the outcome of an ACH return.