Stripe.PaymentMethod (stripity_stripe_fb v2.13.1) View Source

Work with Stripe payment method objects.

Stripe API reference: https://stripe.com/docs/api/payment_methods

Link to this section Summary

Types

au_becs_debit()

billing_details()

card()

sepa_debit()

t()

Functions

attach(params, opts \\ [])

Attach payment_method to customer

create(params, opts \\ [])

Create a payment method.

detach(params, opts \\ [])

Detach payment_method from customer

list(params, opts \\ [])

List all payment methods.

retrieve(id, opts \\ [])

Retrieve a payment method.

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

Update a card.

Link to this section Types

au_becs_debit()

Specs

au_becs_debit() :: %{
  bsb_number: String.t(),
  fingerprint: String.t(),
  last4: String.t()
}

billing_details()

Specs

billing_details() :: %{
  optional(:address) => Stripe.Types.address(),
  optional(:email) => String.t(),
  optional(:name) => String.t(),
  optional(:phone) => String.t()
}

card()

Specs

card() :: %{
  exp_month: integer(),
  exp_year: integer(),
  number: String.t(),
  cvc: String.t()
}

sepa_debit()

Specs

sepa_debit() :: %{
  bank_code: String.t() | nil,
  branch_code: String.t() | nil,
  country: String.t() | nil,
  fingerprint: String.t() | nil,
  last4: String.t() | nil
}

t()

Specs

t() :: %Stripe.PaymentMethod{
  au_becs_debit: au_becs_debit() | nil,
  billing_details: %{
    address: Stripe.Types.address(),
    email: String.t() | nil,
    name: String.t() | nil,
    phone: String.t() | nil
  },
  card: Stripe.Card.t() | nil,
  created: Stripe.timestamp(),
  customer: Stripe.id() | Stripe.Customer.t() | nil,
  id: Stripe.id(),
  link: %{persistent_token: String.t() | nil} | nil,
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  sepa_debit: sepa_debit() | nil,
  type: String.t()
}

Link to this section Functions

attach(params, opts \\ [])

Specs

attach(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       customer: Stripe.id() | Stripe.Customer.t(),
       payment_method: Stripe.id() | t()
     }

Attach payment_method to customer

create(params, opts \\ [])

Specs

create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       :type => String.t(),
       optional(:billing_details) => billing_details(),
       optional(:card) => card(),
       optional(:metadata) => Stripe.Types.metadata()
     }

Create a payment method.

detach(params, opts \\ [])

Specs

detach(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{payment_method: Stripe.id() | t()}

Detach payment_method from customer

list(params, opts \\ [])

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       :customer => Stripe.id() | Stripe.Customer.t(),
       :type => String.t(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:starting_after) => t() | Stripe.id()
     }

List all payment methods.

retrieve(id, opts \\ [])

Specs

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

Retrieve a payment method.

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

Specs

update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:billing_details) => billing_details(),
       optional(:card) => card(),
       optional(:metadata) => Stripe.Types.metadata()
     }

Update a card.

Takes the id and a map of changes