exoapi_stripe v0.1.3

View Source ExOAPI.Stripe.Schemas.PaymentMethod (exoapi_stripe v0.1.3)

description: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

:fpx :: ExOAPI.Stripe.Schemas.PaymentMethodFpx

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:acss_debit :: ExOAPI.Stripe.Schemas.PaymentMethodAcssDebit

:bacs_debit :: ExOAPI.Stripe.Schemas.PaymentMethodBacsDebit

:alipay :: list(:map)

:giropay :: list(:map)

:ideal :: ExOAPI.Stripe.Schemas.PaymentMethodIdeal

:card :: ExOAPI.Stripe.Schemas.PaymentMethodCard

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:oxxo :: list(:map)

:interac_present :: list(:map)

:customer :: ExOAPI.Stripe.Schemas.Customer | :string

The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

:us_bank_account :: ExOAPI.Stripe.Schemas.PaymentMethodUsBankAccount

:boleto :: ExOAPI.Stripe.Schemas.PaymentMethodBoleto

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:konbini :: list(:map)

:billing_details :: ExOAPI.Stripe.Schemas.BillingDetails

:wechat_pay :: list(:map)

:sofort :: ExOAPI.Stripe.Schemas.PaymentMethodSofort

:p24 :: ExOAPI.Stripe.Schemas.PaymentMethodP24

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:afterpay_clearpay :: list(:map)

:type :: :string

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

:grabpay :: list(:map)

:bancontact :: list(:map)

:au_becs_debit :: ExOAPI.Stripe.Schemas.PaymentMethodAuBecsDebit

:customer_balance :: list(:map)

:card_present :: list(:map)

:sepa_debit :: ExOAPI.Stripe.Schemas.PaymentMethodSepaDebit

:klarna :: ExOAPI.Stripe.Schemas.PaymentMethodKlarna

:paynow :: list(:map)

:id :: :string

Unique identifier for the object.

:eps :: ExOAPI.Stripe.Schemas.PaymentMethodEps

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.PaymentMethod{
  acss_debit: ExOAPI.Stripe.Schemas.PaymentMethodAcssDebit.t() | nil,
  afterpay_clearpay: [map()] | nil,
  alipay: [map()] | nil,
  au_becs_debit: ExOAPI.Stripe.Schemas.PaymentMethodAuBecsDebit.t() | nil,
  bacs_debit: ExOAPI.Stripe.Schemas.PaymentMethodBacsDebit.t() | nil,
  bancontact: [map()] | nil,
  billing_details: ExOAPI.Stripe.Schemas.BillingDetails.t() | nil,
  boleto: ExOAPI.Stripe.Schemas.PaymentMethodBoleto.t() | nil,
  card: ExOAPI.Stripe.Schemas.PaymentMethodCard.t() | nil,
  card_present: [map()] | nil,
  created: integer() | nil,
  customer: ExOAPI.EctoTypes.AnyOf.t() | nil,
  customer_balance: [map()] | nil,
  eps: ExOAPI.Stripe.Schemas.PaymentMethodEps.t() | nil,
  fpx: ExOAPI.Stripe.Schemas.PaymentMethodFpx.t() | nil,
  giropay: [map()] | nil,
  grabpay: [map()] | nil,
  id: String.t() | nil,
  ideal: ExOAPI.Stripe.Schemas.PaymentMethodIdeal.t() | nil,
  interac_present: [map()] | nil,
  klarna: ExOAPI.Stripe.Schemas.PaymentMethodKlarna.t() | nil,
  konbini: [map()] | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :payment_method | nil,
  oxxo: [map()] | nil,
  p24: ExOAPI.Stripe.Schemas.PaymentMethodP24.t() | nil,
  paynow: [map()] | nil,
  sepa_debit: ExOAPI.Stripe.Schemas.PaymentMethodSepaDebit.t() | nil,
  sofort: ExOAPI.Stripe.Schemas.PaymentMethodSofort.t() | nil,
  type:
    (:wechat_pay
     | :us_bank_account
     | :sofort
     | :sepa_debit
     | :paynow
     | :p24
     | :oxxo
     | :konbini
     | :klarna
     | :interac_present
     | :ideal
     | :grabpay
     | :giropay
     | :fpx
     | :eps
     | :customer_balance
     | :card_present
     | :card
     | :boleto
     | :bancontact
     | :bacs_debit
     | :au_becs_debit
     | :alipay
     | :afterpay_clearpay
     | :acss_debit)
    | nil,
  us_bank_account: ExOAPI.Stripe.Schemas.PaymentMethodUsBankAccount.t() | nil,
  wechat_pay: [map()] | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()