StripeAPI.Types.ChargeOutcome

Contains the types generated from the schema ChargeOutcome

Documentation

data ChargeOutcome

Defines the data type for the schema charge_outcome

Constructors

ChargeOutcome

Fields

• chargeOutcomeNetworkStatus :: Maybe String

  network_status: Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.

  Constraints:

  • Maximum length of 5000
• chargeOutcomeReason :: Maybe String

  reason: An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See understanding declines for more details.

  Constraints:

  • Maximum length of 5000
• chargeOutcomeRiskLevel :: Maybe String

  risk_level: Stripe's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`.

  Constraints:

  • Maximum length of 5000
• chargeOutcomeRiskScore :: Maybe Integer

  risk_score: Stripe's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.

• chargeOutcomeRule :: Maybe ChargeOutcomeRule'Variants

  rule: The ID of the Radar rule that matched the payment, if applicable.

• chargeOutcomeSellerMessage :: Maybe String

  seller_message: A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.

  Constraints:

  • Maximum length of 5000
• chargeOutcomeType :: String

  type: Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See understanding declines and Radar reviews for details.

  Constraints:

  • Maximum length of 5000

Instances

Eq ChargeOutcome

Defined in StripeAPI.Types.ChargeOutcome

Methods

(==) :: ChargeOutcome -> ChargeOutcome -> Bool

(/=) :: ChargeOutcome -> ChargeOutcome -> Bool

Show ChargeOutcome

Defined in StripeAPI.Types.ChargeOutcome

Methods

showsPrec :: Int -> ChargeOutcome -> ShowS

show :: ChargeOutcome -> String

showList :: [ChargeOutcome] -> ShowS

ToJSON ChargeOutcome

Defined in StripeAPI.Types.ChargeOutcome

Methods

toJSON :: ChargeOutcome -> Value

toEncoding :: ChargeOutcome -> Encoding

toJSONList :: [ChargeOutcome] -> Value

toEncodingList :: [ChargeOutcome] -> Encoding

FromJSON ChargeOutcome

Defined in StripeAPI.Types.ChargeOutcome

Methods

parseJSON :: Value -> Parser ChargeOutcome

parseJSONList :: Value -> Parser [ChargeOutcome]

data ChargeOutcomeRule'Variants

Define the one-of schema charge_outcomeRule'

The ID of the Radar rule that matched the payment, if applicable.

Constructors

ChargeOutcomeRule'Rule Rule

ChargeOutcomeRule'String String

Instances

Eq ChargeOutcomeRule'Variants

Defined in StripeAPI.Types.ChargeOutcome

Methods

(==) :: ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool

(/=) :: ChargeOutcomeRule'Variants -> ChargeOutcomeRule'Variants -> Bool

Show ChargeOutcomeRule'Variants

Defined in StripeAPI.Types.ChargeOutcome

Methods

showsPrec :: Int -> ChargeOutcomeRule'Variants -> ShowS

show :: ChargeOutcomeRule'Variants -> String

showList :: [ChargeOutcomeRule'Variants] -> ShowS

Generic ChargeOutcomeRule'Variants

Defined in StripeAPI.Types.ChargeOutcome

Associated Types

type Rep ChargeOutcomeRule'Variants :: Type -> Type

Methods

from :: ChargeOutcomeRule'Variants -> Rep ChargeOutcomeRule'Variants x

to :: Rep ChargeOutcomeRule'Variants x -> ChargeOutcomeRule'Variants

ToJSON ChargeOutcomeRule'Variants

Defined in StripeAPI.Types.ChargeOutcome

Methods

toJSON :: ChargeOutcomeRule'Variants -> Value

toEncoding :: ChargeOutcomeRule'Variants -> Encoding

toJSONList :: [ChargeOutcomeRule'Variants] -> Value

toEncodingList :: [ChargeOutcomeRule'Variants] -> Encoding

FromJSON ChargeOutcomeRule'Variants

Defined in StripeAPI.Types.ChargeOutcome

Methods

parseJSON :: Value -> Parser ChargeOutcomeRule'Variants

parseJSONList :: Value -> Parser [ChargeOutcomeRule'Variants]

type Rep ChargeOutcomeRule'Variants

Defined in StripeAPI.Types.ChargeOutcome

type Rep ChargeOutcomeRule'Variants = D1 (MetaData "ChargeOutcomeRule'Variants" "StripeAPI.Types.ChargeOutcome" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "ChargeOutcomeRule'Rule" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Rule)) :+: C1 (MetaCons "ChargeOutcomeRule'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))