StripeAPI.Types.ChargeOutcome

Contains the types generated from the schema ChargeOutcome

Documentation

data ChargeOutcome

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

Constructors

ChargeOutcome

Fields

• chargeOutcomeNetworkStatus :: Maybe Text

  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 Text

  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 Text

  risk_level: Stripe Radar'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`. This field is only available with Radar.

  Constraints:

  • Maximum length of 5000
• chargeOutcomeRiskScore :: Maybe Int

  risk_score: Stripe Radar'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 Text

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

  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]

mkChargeOutcome

Arguments

:: Text

chargeOutcomeType

-> ChargeOutcome

Create a new ChargeOutcome with all required fields.

data ChargeOutcomeRule'Variants

Defines the oneOf schema located at components.schemas.charge_outcome.properties.rule.anyOf in the specification.

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

Constructors

ChargeOutcomeRule'Text Text

ChargeOutcomeRule'Rule Rule

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

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]