MollieEx.Refund (mollie_ex v0.2.0)

Copy Markdown View Source

Refund resource returned by the Mollie API.

Stable fields are exposed as snake_case struct fields. The original decoded Mollie response is preserved in raw with upstream JSON casing unchanged.

Summary

Types

links()
t()

Functions

cancelable?(refund)

Returns true when Mollie still allows the refund to be canceled.

canceled?(refund)

Returns true when the refund status is canceled.

failed?(refund)

Returns true when the refund status is failed.

pending?(refund)

Returns true when the refund status is pending.

processing?(refund)

Returns true when the refund status is processing.

queued?(refund)

Returns true when the refund status is queued.

refunded?(refund)

Returns true when the refund status is refunded.

Types

links()

@type links() :: %{optional(String.t()) => MollieEx.Types.Link.t() | term()}

t()

@type t() :: %MollieEx.Refund{
  amount: MollieEx.Types.Money.t() | nil,
  created_at: String.t() | nil,
  description: String.t() | nil,
  external_reference: term(),
  id: String.t(),
  links: links(),
  metadata: term(),
  mode: String.t() | nil,
  order_id: String.t() | nil,
  payment_id: String.t() | nil,
  raw: map(),
  resource: String.t() | nil,
  routing_reversals: term(),
  settlement_amount: MollieEx.Types.Money.t() | nil,
  settlement_id: String.t() | nil,
  status: String.t() | nil
}

Functions

cancelable?(refund)

@spec cancelable?(t() | term()) :: boolean()

Returns true when Mollie still allows the refund to be canceled.

canceled?(refund)

@spec canceled?(t() | term()) :: boolean()

Returns true when the refund status is canceled.

failed?(refund)

@spec failed?(t() | term()) :: boolean()

Returns true when the refund status is failed.

pending?(refund)

@spec pending?(t() | term()) :: boolean()

Returns true when the refund status is pending.

processing?(refund)

@spec processing?(t() | term()) :: boolean()

Returns true when the refund status is processing.

queued?(refund)

@spec queued?(t() | term()) :: boolean()

Returns true when the refund status is queued.

refunded?(refund)

@spec refunded?(t() | term()) :: boolean()

Returns true when the refund status is refunded.