GoCardlessClient.Resources.CreditorBankAccounts (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardlessClient Creditor Bank Accounts API.

See https://developer.gocardless.com/api-reference/#creditor-bank-accounts for full documentation.

Summary

Functions

Eagerly collects all creditor_bank_accounts into a list across all pages.

Creates a new creditor bank accounts resource.

Disables a creditor bank account.

Retrieves a single creditor bank accounts by ID.

Lists creditor_bank_accounts with optional filter params.

Returns a lazy Stream over all pages of creditor_bank_accounts.

Updates a creditor bank accounts.

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 creditor_bank_accounts into a list across all pages.

create(client, params, opts \\ [])

Creates a new creditor bank accounts resource.

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

Disables a creditor bank account.

get(client, id, opts \\ [])

Retrieves a single creditor bank accounts by ID.

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

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

Lists creditor_bank_accounts with optional filter params.

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

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

Returns a lazy Stream over all pages of creditor_bank_accounts.

update(client, id, params, opts \\ [])

Updates a creditor bank accounts.