GoCardlessClient Customer Bank Accounts API.
Customer Bank Accounts represent bank accounts belonging to customers. They are used as the funding source for mandates.
Example
{:ok, account} = GoCardlessClient.Resources.CustomerBankAccounts.create(client, %{
account_holder_name: "Alice Smith",
account_number: "55779911",
branch_code: "200000",
country_code: "GB",
links: %{customer: "CU123"}
})Summary
Functions
Eagerly collects all customer bank accounts into a list.
Creates a customer bank account. Requires account details and a customer link.
Disables a bank account. It can no longer be used for new mandates.
Retrieves a single customer bank account by ID.
Returns a page of customer bank accounts with optional filters.
Returns a lazy Stream over all pages of customer bank accounts.
Updates a customer bank account's metadata.
Functions
@spec collect_all(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, [map()]} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Eagerly collects all customer bank accounts into a list.
@spec create(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Creates a customer bank account. Requires account details and a customer link.
@spec disable(GoCardlessClient.Client.t(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Disables a bank account. It can no longer be used for new mandates.
@spec get(GoCardlessClient.Client.t(), String.t(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Retrieves a single customer bank account by ID.
@spec list(GoCardlessClient.Client.t(), map(), keyword()) :: {:ok, %{items: [map()], meta: map()}} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Returns a page of customer bank accounts with optional filters.
@spec stream(GoCardlessClient.Client.t(), map(), keyword()) :: Enumerable.t()
Returns a lazy Stream over all pages of customer bank accounts.
@spec update(GoCardlessClient.Client.t(), String.t(), map(), keyword()) :: {:ok, map()} | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}
Updates a customer bank account's metadata.