exoapi_stripe v0.1.3

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

:charge :: ExOAPI.Stripe.Schemas.Charge

For card errors, the ID of the failed charge.

:code :: :string

For some errors that could be handled programmatically, a short string indicating the error code reported.

:decline_code :: :string

For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

:doc_url :: :string

A URL to more information about the error code reported.

:message :: :string

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

:param :: :string

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

:payment_intent :: ExOAPI.Stripe.Schemas.PaymentIntent

:payment_method :: ExOAPI.Stripe.Schemas.PaymentMethod

:payment_method_type :: :string

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

:setup_intent :: ExOAPI.Stripe.Schemas.SetupIntent

:source :: ExOAPI.Stripe.Schemas.Source | ExOAPI.Stripe.Schemas.Card | ExOAPI.Stripe.Schemas.BankAccount

The source object for errors returned on a request involving a source.

:type :: :string

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

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.ApiErrors{
  charge: String.t() | nil,
  code: String.t() | nil,
  decline_code: String.t() | nil,
  doc_url: String.t() | nil,
  message: String.t() | nil,
  param: String.t() | nil,
  payment_intent: ExOAPI.Stripe.Schemas.PaymentIntent.t() | nil,
  payment_method: ExOAPI.Stripe.Schemas.PaymentMethod.t() | nil,
  payment_method_type: String.t() | nil,
  setup_intent: ExOAPI.Stripe.Schemas.SetupIntent.t() | nil,
  source: ExOAPI.EctoTypes.AnyOf.t() | nil,
  type:
    (:invalid_request_error | :idempotency_error | :card_error | :api_error)
    | nil
}

Link to this section Functions

Link to this function

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

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