MollieEx.Chargebacks (mollie_ex v0.4.0)

Copy Markdown View Source

Retrieve and list Mollie chargebacks.

All functions return result tuples. They do not raise for ordinary API, transport, or validation failures.

{:ok, chargeback} = MollieEx.Chargebacks.get(client, "tr_123", "chb_123")
{:ok, chargebacks} = MollieEx.Chargebacks.list(client, "tr_123", limit: 10)

Summary

Types

all_option()
get_option()
list_option()

Functions

all(client, opts \\ [])

Lists all Mollie chargebacks.

get(client, payment_id, chargeback_id, opts \\ [])

Retrieves a Mollie chargeback by payment ID and chargeback ID.

list(client, payment_id, opts \\ [])

Lists Mollie chargebacks for a payment.

Types

all_option()

(since 0.2.0) 
@type all_option() ::
  {:from, String.t()}
  | {:limit, pos_integer()}
  | {:sort, :asc | :desc | String.t()}
  | {:embed, String.t()}
  | {:profile_id, String.t()}
  | {:testmode, boolean()}
  | {:pool_timeout, pos_integer()}
  | {:receive_timeout, pos_integer()}
  | {:request_timeout, pos_integer()}

get_option()

(since 0.2.0) 
@type get_option() ::
  {:embed, String.t()}
  | {:testmode, boolean()}
  | {:pool_timeout, pos_integer()}
  | {:receive_timeout, pos_integer()}
  | {:request_timeout, pos_integer()}

list_option()

(since 0.2.0) 
@type list_option() ::
  {:from, String.t()}
  | {:limit, pos_integer()}
  | {:embed, String.t()}
  | {:testmode, boolean()}
  | {:pool_timeout, pos_integer()}
  | {:receive_timeout, pos_integer()}
  | {:request_timeout, pos_integer()}

Functions

all(client, opts \\ [])

(since 0.3.0) 
@spec all(MollieEx.Client.t(), [all_option()]) ::
  {:ok, MollieEx.List.t(MollieEx.Chargeback.t())} | {:error, MollieEx.Error.t()}

Lists all Mollie chargebacks.

This is the top-level chargeback list endpoint. Use list/3 to list chargebacks for a specific payment.

get(client, payment_id, chargeback_id, opts \\ [])

(since 0.2.0) 
@spec get(MollieEx.Client.t(), String.t(), String.t(), [get_option()]) ::
  {:ok, MollieEx.Chargeback.t()} | {:error, MollieEx.Error.t()}

Retrieves a Mollie chargeback by payment ID and chargeback ID.

list(client, payment_id, opts \\ [])

(since 0.2.0) 
@spec list(MollieEx.Client.t(), String.t(), [list_option()]) ::
  {:ok, MollieEx.List.t(MollieEx.Chargeback.t())} | {:error, MollieEx.Error.t()}

Lists Mollie chargebacks for a payment.