GoCardlessClient.Resources.PaymentAccounts (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardless Payment Accounts API.

The GoCardless-held ledger/wallet that funds flow through. Collected payments land here before payout; outbound payments are funded from here.

Payment Accounts are read-only — they are created and managed by GoCardless.

Summary

Functions

Eagerly collects all payment accounts into a list.

Retrieves a single payment account by ID.

Returns a page of payment accounts.

Returns a lazy Stream over all pages of payment 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 payment accounts into a list.

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

Retrieves a single payment account 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()}

Returns a page of payment accounts.

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

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

Returns a lazy Stream over all pages of payment accounts.