Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Review

Contains the types generated from the schema Review

7 types
3 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceReview.hs

datadata Review

Defines the object schema located at components.schemas.review in the specification.

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

Learn more about Radar and reviewing payments here.

Constructors

Review
- reviewBillingZip :: Maybe (Nullable Text)
  billing_zip: The ZIP or postal code of the card used, if applicable.
  Constraints:
  - Maximum length of 5000
- reviewCharge :: Maybe (Nullable ReviewCharge'NonNullableVariants)
  charge: The charge associated with this review.
- reviewClosedReason :: Maybe (Nullable ReviewClosedReason'NonNullable)
  closed_reason: 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`.
- reviewCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- reviewId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- reviewIpAddress :: Maybe (Nullable Text)
  ip_address: The IP address where the payment originated.
  Constraints:
  - Maximum length of 5000
- reviewIpAddressLocation :: Maybe (Nullable ReviewIpAddressLocation'NonNullable)
  ip_address_location: 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.
- reviewLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- reviewOpen :: Bool
  open: If `true`, the review needs action.
- reviewOpenedReason :: ReviewOpenedReason'
  opened_reason: The reason the review was opened. One of `rule` or `manual`.
- reviewPaymentIntent :: Maybe ReviewPaymentIntent'Variants
  payment_intent: The PaymentIntent ID associated with this review, if one exists.
- reviewReason :: Text
  reason: The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.
  Constraints:
  - Maximum length of 5000
- reviewSession :: Maybe (Nullable ReviewSession'NonNullable)
  session: Information related to the browsing session of the user who initiated the payment.

Instances4Eq, Show, FromJSON, ToJSON

Eq ReviewDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
Show ReviewDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
FromJSON ReviewDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
ToJSON ReviewDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review

valuemkReview

:: Int
reviewCreated
-> Text
reviewId
-> Bool
reviewLivemode
-> Bool
reviewOpen
-> ReviewOpenedReason'
reviewOpenedReason
-> Text
reviewReason
-> Review

Create a new Review with all required fields.

datadata ReviewCharge'NonNullableVariants

Defines the oneOf schema located at components.schemas.review.properties.charge.anyOf in the specification.

The charge associated with this review.

Constructors

ReviewCharge'NonNullableText Text
ReviewCharge'NonNullableCharge Charge

Instances4Eq, Show, FromJSON, ToJSON

Eq ReviewCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
Show ReviewCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
FromJSON ReviewCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
ToJSON ReviewCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review

datadata ReviewClosedReason'NonNullable

Defines the enum schema located at components.schemas.review.properties.closed_reason in the specification.

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

Constructors

ReviewClosedReason'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ReviewClosedReason'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
ReviewClosedReason'NonNullableEnumApproved
Represents the JSON value "approved"
ReviewClosedReason'NonNullableEnumDisputed
Represents the JSON value "disputed"
ReviewClosedReason'NonNullableEnumRedacted
Represents the JSON value "redacted"
ReviewClosedReason'NonNullableEnumRefunded
Represents the JSON value "refunded"
ReviewClosedReason'NonNullableEnumRefundedAsFraud
Represents the JSON value "refunded_as_fraud"

Instances4Eq, Show, FromJSON, ToJSON

Eq ReviewClosedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
Show ReviewClosedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
FromJSON ReviewClosedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
ToJSON ReviewClosedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review

datadata ReviewIpAddressLocation'NonNullable

Defines the object schema located at components.schemas.review.properties.ip_address_location.anyOf in the specification.

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.

Constructors

ReviewIpAddressLocation'NonNullable
- reviewIpAddressLocation'NonNullableCity :: Maybe (Nullable Text)
  city: The city where the payment originated.
  Constraints:
  - Maximum length of 5000
- reviewIpAddressLocation'NonNullableCountry :: Maybe (Nullable Text)
  country: Two-letter ISO code representing the country where the payment originated.
  Constraints:
  - Maximum length of 5000
- reviewIpAddressLocation'NonNullableLatitude :: Maybe (Nullable Double)
  latitude: The geographic latitude where the payment originated.
- reviewIpAddressLocation'NonNullableLongitude :: Maybe (Nullable Double)
  longitude: The geographic longitude where the payment originated.
- reviewIpAddressLocation'NonNullableRegion :: Maybe (Nullable Text)
  region: The state/county/province/region where the payment originated.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq ReviewIpAddressLocation'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
Show ReviewIpAddressLocation'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
FromJSON ReviewIpAddressLocation'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
ToJSON ReviewIpAddressLocation'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review

valuemkReviewIpAddressLocation'NonNullable :: ReviewIpAddressLocation'NonNullable

Create a new ReviewIpAddressLocation'NonNullable with all required fields.

datadata ReviewOpenedReason'

Defines the enum schema located at components.schemas.review.properties.opened_reason in the specification.

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

Constructors

ReviewOpenedReason'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ReviewOpenedReason'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
ReviewOpenedReason'EnumManual
Represents the JSON value "manual"
ReviewOpenedReason'EnumRule
Represents the JSON value "rule"

Instances4Eq, Show, FromJSON, ToJSON

Eq ReviewOpenedReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
Show ReviewOpenedReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
FromJSON ReviewOpenedReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
ToJSON ReviewOpenedReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Review

datadata ReviewPaymentIntent'Variants

Defines the oneOf schema located at components.schemas.review.properties.payment_intent.anyOf in the specification.

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

Constructors

ReviewPaymentIntent'Text Text
ReviewPaymentIntent'PaymentIntent PaymentIntent

Instances4Eq, Show, FromJSON, ToJSON

Eq ReviewPaymentIntent'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
Show ReviewPaymentIntent'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
FromJSON ReviewPaymentIntent'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
ToJSON ReviewPaymentIntent'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review

datadata ReviewSession'NonNullable

Defines the object schema located at components.schemas.review.properties.session.anyOf in the specification.

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

Constructors

ReviewSession'NonNullable
- reviewSession'NonNullableBrowser :: Maybe (Nullable Text)
  browser: The browser used in this browser session (e.g., `Chrome`).
  Constraints:
  - Maximum length of 5000
- reviewSession'NonNullableDevice :: Maybe (Nullable Text)
  device: Information about the device used for the browser session (e.g., `Samsung SM-G930T`).
  Constraints:
  - Maximum length of 5000
- reviewSession'NonNullablePlatform :: Maybe (Nullable Text)
  platform: The platform for the browser session (e.g., `Macintosh`).
  Constraints:
  - Maximum length of 5000
- reviewSession'NonNullableVersion :: Maybe (Nullable Text)
  version: The version for the browser session (e.g., `61.0.3163.100`).
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq ReviewSession'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
Show ReviewSession'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
FromJSON ReviewSession'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review
ToJSON ReviewSession'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Review

valuemkReviewSession'NonNullable :: ReviewSession'NonNullable

Create a new ReviewSession'NonNullable with all required fields.