GoCardlessClient.Resources.NegativeBalanceLimits (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardless Negative Balance Limits API.

Returns the configured limits on how negative a creditor's balance can go before payouts are automatically paused. This can happen when refunds, chargebacks, or fees exceed collected payments.

These limits are configured by GoCardless — they cannot be created or updated via the API.

Summary

Functions

collect_all(client, params \\ %{}, opts \\ [])

Eagerly collects all negative balance limits into a list.

list(client, params \\ %{}, opts \\ [])

Returns a page of negative balance limits.

stream(client, params \\ %{}, opts \\ [])

Returns a lazy Stream over all negative balance limits.

Functions

collect_all(client, params \\ %{}, opts \\ [])

@spec collect_all(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, [map()]}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Eagerly collects all negative balance limits into a list.

list(client, params \\ %{}, opts \\ [])

@spec list(GoCardlessClient.Client.t(), map(), keyword()) ::
  {:ok, %{items: [map()], meta: map()}}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Returns a page of negative balance limits.

stream(client, params \\ %{}, opts \\ [])

@spec stream(GoCardlessClient.Client.t(), map(), keyword()) :: Enumerable.t()

Returns a lazy Stream over all negative balance limits.