exoapi_stripe v0.1.4

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

description: Reviews can be used to supplement automated fraud detection with human expertise.

Learn more about Radar and reviewing payments here.

:billing_zip :: :string

The ZIP or postal code of the card used, if applicable.

:charge :: ExOAPI.Stripe.Schemas.Charge | :string

The charge associated with this review.

:closed_reason :: :string

The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, or redacted.

:created :: :integer

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

:id :: :string

Unique identifier for the object.

:ip_address :: :string

The IP address where the payment originated.

:ip_address_location :: ExOAPI.Stripe.Schemas.RadarReviewResourceLocation

Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.

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

:open :: :boolean

If true, the review needs action.

:opened_reason :: :string

The reason the review was opened. One of rule or manual.

:payment_intent :: ExOAPI.Stripe.Schemas.PaymentIntent | :string

The PaymentIntent ID associated with this review, if one exists.

:reason :: :string

The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, or redacted.

:session :: ExOAPI.Stripe.Schemas.RadarReviewResourceSession

Information related to the browsing session of the user who initiated the payment.

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.Review{
  billing_zip: String.t() | nil,
  charge: ExOAPI.EctoTypes.AnyOf.t() | nil,
  closed_reason:
    (:refunded_as_fraud | :refunded | :redacted | :disputed | :approved) | nil,
  created: integer() | nil,
  id: String.t() | nil,
  ip_address: String.t() | nil,
  ip_address_location: ExOAPI.EctoTypes.AnyOf.t() | nil,
  livemode: boolean() | nil,
  object: :review | nil,
  open: boolean() | nil,
  opened_reason: (:rule | :manual) | nil,
  payment_intent: ExOAPI.EctoTypes.AnyOf.t() | nil,
  reason: String.t() | nil,
  session: ExOAPI.EctoTypes.AnyOf.t() | nil
}

Link to this section Functions

Link to this function

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

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