Plaid.Processor.get_balance

You're seeing just the function get_balance, go back to Plaid.Processor module for more information.
Link to this function

get_balance(processor_token, config)

View Source

Specs

get_balance(String.t(), Plaid.config()) ::
  {:ok, Plaid.Processor.GetBalanceResponse.t()} | {:error, Plaid.Error.t()}

Get real-time balance for each of an Item's accounts.

Does a POST /processor/balance/get call which returns the balance for each of a Item's accounts.

While other endpoints may return a balance object, only /processor/balance/get forces the available and current balance fields to be refreshed rather than cached.

Params:

  • processor_token - The processor token obtained from the Plaid integration partner.

Examples

Processor.get_balance("processor-prod-123xxx", client_id: "123", secret: "abc")
{:ok, %Processor.GetBalanceResponse{}}