Stripe.Mandate (stripity_stripe v2.17.2) View Source

A Mandate is a record of the permission a customer has given you to debit their payment method.

You can:

Retrieve a Mandate

Link to this section Summary

Types

customer_acceptance()

payment_method_details()

t()

Functions

retrieve(id, opts \\ [])

Retrieves a Mandate that has previously been created. See the Stripe docs.

Link to this section Types

customer_acceptance()

Specs

customer_acceptance() :: %{
  :accepted_at => Stripe.timestamp(),
  optional(:offline) => %{},
  optional(:online) => %{ip_address: String.t(), user_agent: String.t()},
  type: String.t()
}

payment_method_details()

Specs

payment_method_details() :: %{
  optional(:au_becs_debit) => %{url: String.t()},
  optional(:card) => %{},
  optional(:sepa_debit) => %{reference: String.t(), url: String.t()},
  type: String.t()
}

t()

Specs

t() :: %Stripe.Mandate{
  customer_acceptance: customer_acceptance(),
  id: Stripe.id(),
  livemode: boolean(),
  multi_use: map(),
  object: String.t(),
  payment_method: Stripe.id() | Stripe.PaymentMethod.t() | nil,
  payment_method_details: payment_method_details(),
  status: String.t(),
  type: String.t()
}

Link to this section Functions

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieves a Mandate that has previously been created. See the Stripe docs.