GoCardlessClient.Resources.OutboundPaymentImportEntries (GoCardlessClient v2.0.0)

Copy Markdown View Source

GoCardless Outbound Payment Import Entries API.

Individual payment entries within an Outbound Payment Import batch.

Example

{:ok, %{items: entries}} = GoCardlessClient.Resources.OutboundPaymentImportEntries.list(
  client,
  %{outbound_payment_import: "OPI123"}
)

Summary

Functions

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

Eagerly collects all import entries into a list.

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

Lists all entries for an outbound payment import.

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

Returns a lazy Stream over all entries in an outbound payment import.

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 import entries 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()}

Lists all entries for an outbound payment import.

The :outbound_payment_import filter is required.

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

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

Returns a lazy Stream over all entries in an outbound payment import.