exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Source (exoapi_stripe v0.1.4)

description: Source objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a Card object: once chargeable, they can be charged, or can be attached to customers.

Related guides: Sources API and Sources & Customers.

: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.SourceTypeAcssDebit

:ach_debit :: ExOAPI.Stripe.Schemas.SourceTypeAchDebit

:alipay :: ExOAPI.Stripe.Schemas.SourceTypeAlipay

:giropay :: ExOAPI.Stripe.Schemas.SourceTypeGiropay

:redirect :: ExOAPI.Stripe.Schemas.SourceRedirectFlow

:ideal :: ExOAPI.Stripe.Schemas.SourceTypeIdeal

:code_verification :: ExOAPI.Stripe.Schemas.SourceCodeVerificationFlow

:card :: ExOAPI.Stripe.Schemas.SourceTypeCard

: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.

:multibanco :: ExOAPI.Stripe.Schemas.SourceTypeMultibanco

:usage :: :string

Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

:receiver :: ExOAPI.Stripe.Schemas.SourceReceiverFlow

:customer :: ExOAPI.Stripe.Schemas.Customer

The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.

:ach_credit_transfer :: ExOAPI.Stripe.Schemas.SourceTypeAchCreditTransfer

:amount :: :integer

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.

:statement_descriptor :: :string

Extra information about a source. This will appear on your customer's statement every time you charge the source.

:wechat :: ExOAPI.Stripe.Schemas.SourceTypeWechat

:client_secret :: :string

The client secret of the source. Used for client-side retrieval using a publishable key.

:object :: :string

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

:sofort :: ExOAPI.Stripe.Schemas.SourceTypeSofort

:p24 :: ExOAPI.Stripe.Schemas.SourceTypeP24

:currency :: :string

Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.

:created :: :integer

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

:type :: :string

The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.

:status :: :string

The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.

:bancontact :: ExOAPI.Stripe.Schemas.SourceTypeBancontact

:three_d_secure :: ExOAPI.Stripe.Schemas.SourceTypeThreeDSecure

:au_becs_debit :: ExOAPI.Stripe.Schemas.SourceTypeAuBecsDebit

:card_present :: ExOAPI.Stripe.Schemas.SourceTypeCardPresent

:flow :: :string

The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.

:sepa_debit :: ExOAPI.Stripe.Schemas.SourceTypeSepaDebit

:klarna :: ExOAPI.Stripe.Schemas.SourceTypeKlarna

:source_order :: ExOAPI.Stripe.Schemas.SourceOrder

:id :: :string

Unique identifier for the object.

:owner :: ExOAPI.Stripe.Schemas.SourceOwner

Information about the owner of the payment instrument that may be used or required by particular source types.

:eps :: ExOAPI.Stripe.Schemas.SourceTypeEps

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.Source{
  ach_credit_transfer:
    ExOAPI.Stripe.Schemas.SourceTypeAchCreditTransfer.t() | nil,
  ach_debit: ExOAPI.Stripe.Schemas.SourceTypeAchDebit.t() | nil,
  acss_debit: ExOAPI.Stripe.Schemas.SourceTypeAcssDebit.t() | nil,
  alipay: ExOAPI.Stripe.Schemas.SourceTypeAlipay.t() | nil,
  amount: integer() | nil,
  au_becs_debit: ExOAPI.Stripe.Schemas.SourceTypeAuBecsDebit.t() | nil,
  bancontact: ExOAPI.Stripe.Schemas.SourceTypeBancontact.t() | nil,
  card: ExOAPI.Stripe.Schemas.SourceTypeCard.t() | nil,
  card_present: ExOAPI.Stripe.Schemas.SourceTypeCardPresent.t() | nil,
  client_secret: String.t() | nil,
  code_verification: ExOAPI.Stripe.Schemas.SourceCodeVerificationFlow.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  customer: String.t() | nil,
  eps: ExOAPI.Stripe.Schemas.SourceTypeEps.t() | nil,
  flow: String.t() | nil,
  giropay: ExOAPI.Stripe.Schemas.SourceTypeGiropay.t() | nil,
  id: String.t() | nil,
  ideal: ExOAPI.Stripe.Schemas.SourceTypeIdeal.t() | nil,
  klarna: ExOAPI.Stripe.Schemas.SourceTypeKlarna.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  multibanco: ExOAPI.Stripe.Schemas.SourceTypeMultibanco.t() | nil,
  object: :source | nil,
  owner: ExOAPI.EctoTypes.AnyOf.t() | nil,
  p24: ExOAPI.Stripe.Schemas.SourceTypeP24.t() | nil,
  receiver: ExOAPI.Stripe.Schemas.SourceReceiverFlow.t() | nil,
  redirect: ExOAPI.Stripe.Schemas.SourceRedirectFlow.t() | nil,
  sepa_debit: ExOAPI.Stripe.Schemas.SourceTypeSepaDebit.t() | nil,
  sofort: ExOAPI.Stripe.Schemas.SourceTypeSofort.t() | nil,
  source_order: ExOAPI.Stripe.Schemas.SourceOrder.t() | nil,
  statement_descriptor: String.t() | nil,
  status: String.t() | nil,
  three_d_secure: ExOAPI.Stripe.Schemas.SourceTypeThreeDSecure.t() | nil,
  type:
    (:wechat
     | :three_d_secure
     | :sofort
     | :sepa_debit
     | :p24
     | :multibanco
     | :klarna
     | :ideal
     | :giropay
     | :eps
     | :card_present
     | :card
     | :bancontact
     | :au_becs_debit
     | :alipay
     | :acss_debit
     | :ach_debit
     | :ach_credit_transfer)
    | nil,
  usage: String.t() | nil,
  wechat: ExOAPI.Stripe.Schemas.SourceTypeWechat.t() | nil
}

Link to this section Functions

Link to this function

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

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