View Source Stripe.Radar.EarlyFraudWarning (stripity_stripe v3.2.0)

An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent.

Related guide: Early fraud warnings

Summary

Types

created()
t()

The radar.early_fraud_warning type.

Functions

list(params \\ %{}, opts \\ [])

Returns a list of early fraud warnings.

retrieve(early_fraud_warning, params \\ %{}, opts \\ [])

Retrieves the details of an early fraud warning that has previously been created.

Types

Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

t()

View Source 
@type t() :: %Stripe.Radar.EarlyFraudWarning{
  actionable: boolean(),
  charge: binary() | Stripe.Charge.t(),
  created: integer(),
  fraud_type: binary(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  payment_intent: binary() | Stripe.PaymentIntent.t()
}

The radar.early_fraud_warning type.

  • actionable An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.
  • charge ID of the charge this early fraud warning is for, optionally expanded.
  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • fraud_type The type of fraud labelled by the issuer. One of card_never_received, fraudulent_card_application, made_with_counterfeit_card, made_with_lost_card, made_with_stolen_card, misc, unauthorized_use_of_card.
  • id Unique identifier for the object.
  • livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object String representing the object's type. Objects of the same type share the same value.
  • payment_intent ID of the Payment Intent this early fraud warning is for, optionally expanded.

Functions

Link to this function

list(params \\ %{}, opts \\ [])

View Source 
@spec list(
  params :: %{
    optional(:charge) => binary(),
    optional(:created) => created() | integer(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:payment_intent) => binary(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of early fraud warnings.

Details

  • Method: get
  • Path: /v1/radar/early_fraud_warnings
Link to this function

retrieve(early_fraud_warning, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  early_fraud_warning :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of an early fraud warning that has previously been created.

Please refer to the early fraud warning object reference for more details.

Details

  • Method: get
  • Path: /v1/radar/early_fraud_warnings/{early_fraud_warning}