GoCardlessClient.Resources.Refunds (GoCardlessClient v2.0.0)

GoCardlessClient Refunds API.

Refunds return collected funds to a customer's bank account.

Example

{:ok, refund} = GoCardlessClient.Resources.Refunds.create(client, %{
  amount: 500,
  reference: "REFUND-001",
  metadata: %{reason: "customer_request"},
  links: %{payment: "PM123"}
}, idempotency_key: GoCardlessClient.new_idempotency_key())

Summary

Functions

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

Eagerly collects all refunds into a list.

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

Creates a refund against a payment. Pass an idempotency key for safe retries.

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

Retrieves a single refund by ID.

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

Returns a page of refunds with optional filters.

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

Returns a lazy Stream over all pages of refunds.

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

Updates a refund's metadata.

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 refunds into a list.

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

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

Creates a refund against a payment. Pass an idempotency key for safe retries.

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

@spec get(GoCardlessClient.Client.t(), String.t(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Retrieves a single refund 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 refunds with optional filters.

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

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

Returns a lazy Stream over all pages of refunds.

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

@spec update(GoCardlessClient.Client.t(), String.t(), map(), keyword()) ::
  {:ok, map()}
  | {:error, GoCardlessClient.APIError.t() | GoCardlessClient.Error.t()}

Updates a refund's metadata.