Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.Dispute

Description

Contains the types generated from the schema Dispute

Synopsis

data Dispute = Dispute {
- disputeAmount :: Int
- disputeBalanceTransactions :: [BalanceTransaction]
- disputeCharge :: DisputeCharge'Variants
- disputeCreated :: Int
- disputeCurrency :: Text
- disputeEvidence :: DisputeEvidence
- disputeEvidenceDetails :: DisputeEvidenceDetails
- disputeId :: Text
- disputeIsChargeRefundable :: Bool
- disputeLivemode :: Bool
- disputeMetadata :: Object
- disputePaymentIntent :: Maybe DisputePaymentIntent'Variants
- disputeReason :: Text
- disputeStatus :: DisputeStatus'
}
mkDispute :: Int -> [BalanceTransaction] -> DisputeCharge'Variants -> Int -> Text -> DisputeEvidence -> DisputeEvidenceDetails -> Text -> Bool -> Bool -> Object -> Text -> DisputeStatus' -> Dispute
data DisputeCharge'Variants
- = DisputeCharge'Text Text
- | DisputeCharge'Charge Charge
data DisputePaymentIntent'Variants
- = DisputePaymentIntent'Text Text
- | DisputePaymentIntent'PaymentIntent PaymentIntent
data DisputeStatus'

Documentation

data Dispute Source #

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

A dispute occurs when a customer questions your charge with their card issuer. When this happens, you're given the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. You can find more information about the dispute process in our Disputes and Fraud documentation.

Related guide: Disputes and Fraud.

Constructors

Dispute

Fields

disputeAmount :: Int
amount: Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
disputeBalanceTransactions :: [BalanceTransaction]
balance_transactions: List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
disputeCharge :: DisputeCharge'Variants
charge: ID of the charge that was disputed.
disputeCreated :: Int
created: Time at which the object was created. Measured in seconds since the Unix epoch.
disputeCurrency :: Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
disputeEvidence :: DisputeEvidence
evidence:
disputeEvidenceDetails :: DisputeEvidenceDetails
evidence_details:
disputeId :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
disputeIsChargeRefundable :: Bool
is_charge_refundable: If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
disputeLivemode :: Bool
livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
disputeMetadata :: Object
metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
disputePaymentIntent :: Maybe DisputePaymentIntent'Variants
payment_intent: ID of the PaymentIntent that was disputed.
disputeReason :: Text
reason: Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Read more about dispute reasons.
Constraints:
- Maximum length of 5000
disputeStatus :: DisputeStatus'
status: Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`.

Instances

Instances details

Eq Dispute Source #
Instance details Defined in StripeAPI.Types.Dispute Methods (==) :: Dispute -> Dispute -> Bool # (/=) :: Dispute -> Dispute -> Bool #
Show Dispute Source #
Instance details Defined in StripeAPI.Types.Dispute Methods showsPrec :: Int -> Dispute -> ShowS # show :: Dispute -> String # showList :: [Dispute] -> ShowS #
ToJSON Dispute Source #
Instance details Defined in StripeAPI.Types.Dispute Methods toJSON :: Dispute -> Value # toEncoding :: Dispute -> Encoding # toJSONList :: [Dispute] -> Value # toEncodingList :: [Dispute] -> Encoding #
FromJSON Dispute Source #
Instance details Defined in StripeAPI.Types.Dispute Methods parseJSON :: Value -> Parser Dispute # parseJSONList :: Value -> Parser [Dispute] #

mkDispute Source #

Arguments

:: Int	`disputeAmount`
-> [BalanceTransaction]	`disputeBalanceTransactions`
-> DisputeCharge'Variants	`disputeCharge`
-> Int	`disputeCreated`
-> Text	`disputeCurrency`
-> DisputeEvidence	`disputeEvidence`
-> DisputeEvidenceDetails	`disputeEvidenceDetails`
-> Text	`disputeId`
-> Bool	`disputeIsChargeRefundable`
-> Bool	`disputeLivemode`
-> Object	`disputeMetadata`
-> Text	`disputeReason`
-> DisputeStatus'	`disputeStatus`
-> Dispute

Create a new Dispute with all required fields.

data DisputeCharge'Variants Source #

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

ID of the charge that was disputed.

Constructors

DisputeCharge'Text Text
DisputeCharge'Charge Charge

Instances

Instances details

Eq DisputeCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods (==) :: DisputeCharge'Variants -> DisputeCharge'Variants -> Bool # (/=) :: DisputeCharge'Variants -> DisputeCharge'Variants -> Bool #
Show DisputeCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods showsPrec :: Int -> DisputeCharge'Variants -> ShowS # show :: DisputeCharge'Variants -> String # showList :: [DisputeCharge'Variants] -> ShowS #
ToJSON DisputeCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods toJSON :: DisputeCharge'Variants -> Value # toEncoding :: DisputeCharge'Variants -> Encoding # toJSONList :: [DisputeCharge'Variants] -> Value # toEncodingList :: [DisputeCharge'Variants] -> Encoding #
FromJSON DisputeCharge'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods parseJSON :: Value -> Parser DisputeCharge'Variants # parseJSONList :: Value -> Parser [DisputeCharge'Variants] #

data DisputePaymentIntent'Variants Source #

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

ID of the PaymentIntent that was disputed.

Constructors

DisputePaymentIntent'Text Text
DisputePaymentIntent'PaymentIntent PaymentIntent

Instances

Instances details

Eq DisputePaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods (==) :: DisputePaymentIntent'Variants -> DisputePaymentIntent'Variants -> Bool # (/=) :: DisputePaymentIntent'Variants -> DisputePaymentIntent'Variants -> Bool #
Show DisputePaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods showsPrec :: Int -> DisputePaymentIntent'Variants -> ShowS # show :: DisputePaymentIntent'Variants -> String # showList :: [DisputePaymentIntent'Variants] -> ShowS #
ToJSON DisputePaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods toJSON :: DisputePaymentIntent'Variants -> Value # toEncoding :: DisputePaymentIntent'Variants -> Encoding # toJSONList :: [DisputePaymentIntent'Variants] -> Value # toEncodingList :: [DisputePaymentIntent'Variants] -> Encoding #
FromJSON DisputePaymentIntent'Variants Source #
Instance details Defined in StripeAPI.Types.Dispute Methods parseJSON :: Value -> Parser DisputePaymentIntent'Variants # parseJSONList :: Value -> Parser [DisputePaymentIntent'Variants] #

data DisputeStatus' Source #

Defines the enum schema located at components.schemas.dispute.properties.status in the specification.

Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`.

Constructors

DisputeStatus'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
DisputeStatus'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
DisputeStatus'EnumChargeRefunded	Represents the JSON value `"charge_refunded"`
DisputeStatus'EnumLost	Represents the JSON value `"lost"`
DisputeStatus'EnumNeedsResponse	Represents the JSON value `"needs_response"`
DisputeStatus'EnumUnderReview	Represents the JSON value `"under_review"`
DisputeStatus'EnumWarningClosed	Represents the JSON value `"warning_closed"`
DisputeStatus'EnumWarningNeedsResponse	Represents the JSON value `"warning_needs_response"`
DisputeStatus'EnumWarningUnderReview	Represents the JSON value `"warning_under_review"`
DisputeStatus'EnumWon	Represents the JSON value `"won"`

Instances

Instances details

Eq DisputeStatus' Source #
Instance details Defined in StripeAPI.Types.Dispute Methods (==) :: DisputeStatus' -> DisputeStatus' -> Bool # (/=) :: DisputeStatus' -> DisputeStatus' -> Bool #
Show DisputeStatus' Source #
Instance details Defined in StripeAPI.Types.Dispute Methods showsPrec :: Int -> DisputeStatus' -> ShowS # show :: DisputeStatus' -> String # showList :: [DisputeStatus'] -> ShowS #
ToJSON DisputeStatus' Source #
Instance details Defined in StripeAPI.Types.Dispute Methods toJSON :: DisputeStatus' -> Value # toEncoding :: DisputeStatus' -> Encoding # toJSONList :: [DisputeStatus'] -> Value # toEncodingList :: [DisputeStatus'] -> Encoding #
FromJSON DisputeStatus' Source #
Instance details Defined in StripeAPI.Types.Dispute Methods parseJSON :: Value -> Parser DisputeStatus' # parseJSONList :: Value -> Parser [DisputeStatus'] #