exoapi_stripe v0.1.4

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

description: Cardholder authentication via 3D Secure is initiated by creating a 3D Secure object. Once the object has been created, you can use it to authenticate the cardholder and create a charge.

:amount :: :integer

Amount of the charge that you will create when authentication completes.

:authenticated :: :boolean

True if the cardholder went through the authentication flow and their bank indicated that authentication succeeded.

:card :: ExOAPI.Stripe.Schemas.Card

:created :: :integer

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

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

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

:object :: :string

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

:redirect_url :: :string

If present, this is the URL that you should send the cardholder to for authentication. If you are going to use Stripe.js to display the authentication page in an iframe, you should use the value "_callback".

:status :: :string

Possible values are redirect_pending, succeeded, or failed. When the cardholder can be authenticated, the object starts with status redirect_pending. When liability will be shifted to the cardholder's bank (either because the cardholder was successfully authenticated, or because the bank has not implemented 3D Secure, the object wlil be in status succeeded. failed indicates that authentication was attempted unsuccessfully.

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.ThreeDSecure{
  amount: integer() | nil,
  authenticated: boolean() | nil,
  card: ExOAPI.Stripe.Schemas.Card.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  object: :three_d_secure | nil,
  redirect_url: String.t() | nil,
  status: String.t() | nil
}

Link to this section Functions

Link to this function

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

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