stripe_shared/
dispute.rs

1/// A dispute occurs when a customer questions your charge with their card issuer.
2/// When this happens, you have the opportunity to respond to the dispute with
3/// evidence that shows that the charge is legitimate.
4///
5/// Related guide: [Disputes and fraud](https://stripe.com/docs/disputes)
6///
7/// For more details see <<https://stripe.com/docs/api/disputes/object>>.
8#[derive(Clone, Debug)]
9#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
10pub struct Dispute {
11    /// Disputed amount.
12    /// Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
13    pub amount: i64,
14    /// List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
15    pub balance_transactions: Vec<stripe_shared::BalanceTransaction>,
16    /// ID of the charge that's disputed.
17    pub charge: stripe_types::Expandable<stripe_shared::Charge>,
18    /// Time at which the object was created. Measured in seconds since the Unix epoch.
19    pub created: stripe_types::Timestamp,
20    /// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
21    /// Must be a [supported currency](https://stripe.com/docs/currencies).
22    pub currency: stripe_types::Currency,
23    /// List of eligibility types that are included in `enhanced_evidence`.
24    pub enhanced_eligibility_types: Vec<DisputeEnhancedEligibilityTypes>,
25    pub evidence: stripe_shared::DisputeEvidence,
26    pub evidence_details: stripe_shared::DisputeEvidenceDetails,
27    /// Unique identifier for the object.
28    pub id: stripe_shared::DisputeId,
29    /// If true, it's still possible to refund the disputed payment.
30    /// After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
31    pub is_charge_refundable: bool,
32    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
33    pub livemode: bool,
34    /// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
35    /// This can be useful for storing additional information about the object in a structured format.
36    pub metadata: std::collections::HashMap<String, String>,
37    /// Network-dependent reason code for the dispute.
38    pub network_reason_code: Option<String>,
39    /// ID of the PaymentIntent that's disputed.
40    pub payment_intent: Option<stripe_types::Expandable<stripe_shared::PaymentIntent>>,
41    pub payment_method_details: Option<stripe_shared::DisputePaymentMethodDetails>,
42    /// Reason given by cardholder for dispute.
43    /// Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`.
44    /// Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
45    pub reason: String,
46    /// The current status of a dispute.
47    /// Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
48    pub status: DisputeStatus,
49}
50#[doc(hidden)]
51pub struct DisputeBuilder {
52    amount: Option<i64>,
53    balance_transactions: Option<Vec<stripe_shared::BalanceTransaction>>,
54    charge: Option<stripe_types::Expandable<stripe_shared::Charge>>,
55    created: Option<stripe_types::Timestamp>,
56    currency: Option<stripe_types::Currency>,
57    enhanced_eligibility_types: Option<Vec<DisputeEnhancedEligibilityTypes>>,
58    evidence: Option<stripe_shared::DisputeEvidence>,
59    evidence_details: Option<stripe_shared::DisputeEvidenceDetails>,
60    id: Option<stripe_shared::DisputeId>,
61    is_charge_refundable: Option<bool>,
62    livemode: Option<bool>,
63    metadata: Option<std::collections::HashMap<String, String>>,
64    network_reason_code: Option<Option<String>>,
65    payment_intent: Option<Option<stripe_types::Expandable<stripe_shared::PaymentIntent>>>,
66    payment_method_details: Option<Option<stripe_shared::DisputePaymentMethodDetails>>,
67    reason: Option<String>,
68    status: Option<DisputeStatus>,
69}
70
71#[allow(
72    unused_variables,
73    irrefutable_let_patterns,
74    clippy::let_unit_value,
75    clippy::match_single_binding,
76    clippy::single_match
77)]
78const _: () = {
79    use miniserde::de::{Map, Visitor};
80    use miniserde::json::Value;
81    use miniserde::{make_place, Deserialize, Result};
82    use stripe_types::miniserde_helpers::FromValueOpt;
83    use stripe_types::{MapBuilder, ObjectDeser};
84
85    make_place!(Place);
86
87    impl Deserialize for Dispute {
88        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
89            Place::new(out)
90        }
91    }
92
93    struct Builder<'a> {
94        out: &'a mut Option<Dispute>,
95        builder: DisputeBuilder,
96    }
97
98    impl Visitor for Place<Dispute> {
99        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
100            Ok(Box::new(Builder { out: &mut self.out, builder: DisputeBuilder::deser_default() }))
101        }
102    }
103
104    impl MapBuilder for DisputeBuilder {
105        type Out = Dispute;
106        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
107            Ok(match k {
108                "amount" => Deserialize::begin(&mut self.amount),
109                "balance_transactions" => Deserialize::begin(&mut self.balance_transactions),
110                "charge" => Deserialize::begin(&mut self.charge),
111                "created" => Deserialize::begin(&mut self.created),
112                "currency" => Deserialize::begin(&mut self.currency),
113                "enhanced_eligibility_types" => {
114                    Deserialize::begin(&mut self.enhanced_eligibility_types)
115                }
116                "evidence" => Deserialize::begin(&mut self.evidence),
117                "evidence_details" => Deserialize::begin(&mut self.evidence_details),
118                "id" => Deserialize::begin(&mut self.id),
119                "is_charge_refundable" => Deserialize::begin(&mut self.is_charge_refundable),
120                "livemode" => Deserialize::begin(&mut self.livemode),
121                "metadata" => Deserialize::begin(&mut self.metadata),
122                "network_reason_code" => Deserialize::begin(&mut self.network_reason_code),
123                "payment_intent" => Deserialize::begin(&mut self.payment_intent),
124                "payment_method_details" => Deserialize::begin(&mut self.payment_method_details),
125                "reason" => Deserialize::begin(&mut self.reason),
126                "status" => Deserialize::begin(&mut self.status),
127
128                _ => <dyn Visitor>::ignore(),
129            })
130        }
131
132        fn deser_default() -> Self {
133            Self {
134                amount: Deserialize::default(),
135                balance_transactions: Deserialize::default(),
136                charge: Deserialize::default(),
137                created: Deserialize::default(),
138                currency: Deserialize::default(),
139                enhanced_eligibility_types: Deserialize::default(),
140                evidence: Deserialize::default(),
141                evidence_details: Deserialize::default(),
142                id: Deserialize::default(),
143                is_charge_refundable: Deserialize::default(),
144                livemode: Deserialize::default(),
145                metadata: Deserialize::default(),
146                network_reason_code: Deserialize::default(),
147                payment_intent: Deserialize::default(),
148                payment_method_details: Deserialize::default(),
149                reason: Deserialize::default(),
150                status: Deserialize::default(),
151            }
152        }
153
154        fn take_out(&mut self) -> Option<Self::Out> {
155            let (
156                Some(amount),
157                Some(balance_transactions),
158                Some(charge),
159                Some(created),
160                Some(currency),
161                Some(enhanced_eligibility_types),
162                Some(evidence),
163                Some(evidence_details),
164                Some(id),
165                Some(is_charge_refundable),
166                Some(livemode),
167                Some(metadata),
168                Some(network_reason_code),
169                Some(payment_intent),
170                Some(payment_method_details),
171                Some(reason),
172                Some(status),
173            ) = (
174                self.amount,
175                self.balance_transactions.take(),
176                self.charge.take(),
177                self.created,
178                self.currency.take(),
179                self.enhanced_eligibility_types.take(),
180                self.evidence.take(),
181                self.evidence_details.take(),
182                self.id.take(),
183                self.is_charge_refundable,
184                self.livemode,
185                self.metadata.take(),
186                self.network_reason_code.take(),
187                self.payment_intent.take(),
188                self.payment_method_details.take(),
189                self.reason.take(),
190                self.status,
191            )
192            else {
193                return None;
194            };
195            Some(Self::Out {
196                amount,
197                balance_transactions,
198                charge,
199                created,
200                currency,
201                enhanced_eligibility_types,
202                evidence,
203                evidence_details,
204                id,
205                is_charge_refundable,
206                livemode,
207                metadata,
208                network_reason_code,
209                payment_intent,
210                payment_method_details,
211                reason,
212                status,
213            })
214        }
215    }
216
217    impl Map for Builder<'_> {
218        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
219            self.builder.key(k)
220        }
221
222        fn finish(&mut self) -> Result<()> {
223            *self.out = self.builder.take_out();
224            Ok(())
225        }
226    }
227
228    impl ObjectDeser for Dispute {
229        type Builder = DisputeBuilder;
230    }
231
232    impl FromValueOpt for Dispute {
233        fn from_value(v: Value) -> Option<Self> {
234            let Value::Object(obj) = v else {
235                return None;
236            };
237            let mut b = DisputeBuilder::deser_default();
238            for (k, v) in obj {
239                match k.as_str() {
240                    "amount" => b.amount = FromValueOpt::from_value(v),
241                    "balance_transactions" => b.balance_transactions = FromValueOpt::from_value(v),
242                    "charge" => b.charge = FromValueOpt::from_value(v),
243                    "created" => b.created = FromValueOpt::from_value(v),
244                    "currency" => b.currency = FromValueOpt::from_value(v),
245                    "enhanced_eligibility_types" => {
246                        b.enhanced_eligibility_types = FromValueOpt::from_value(v)
247                    }
248                    "evidence" => b.evidence = FromValueOpt::from_value(v),
249                    "evidence_details" => b.evidence_details = FromValueOpt::from_value(v),
250                    "id" => b.id = FromValueOpt::from_value(v),
251                    "is_charge_refundable" => b.is_charge_refundable = FromValueOpt::from_value(v),
252                    "livemode" => b.livemode = FromValueOpt::from_value(v),
253                    "metadata" => b.metadata = FromValueOpt::from_value(v),
254                    "network_reason_code" => b.network_reason_code = FromValueOpt::from_value(v),
255                    "payment_intent" => b.payment_intent = FromValueOpt::from_value(v),
256                    "payment_method_details" => {
257                        b.payment_method_details = FromValueOpt::from_value(v)
258                    }
259                    "reason" => b.reason = FromValueOpt::from_value(v),
260                    "status" => b.status = FromValueOpt::from_value(v),
261
262                    _ => {}
263                }
264            }
265            b.take_out()
266        }
267    }
268};
269#[cfg(feature = "serialize")]
270impl serde::Serialize for Dispute {
271    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
272        use serde::ser::SerializeStruct;
273        let mut s = s.serialize_struct("Dispute", 18)?;
274        s.serialize_field("amount", &self.amount)?;
275        s.serialize_field("balance_transactions", &self.balance_transactions)?;
276        s.serialize_field("charge", &self.charge)?;
277        s.serialize_field("created", &self.created)?;
278        s.serialize_field("currency", &self.currency)?;
279        s.serialize_field("enhanced_eligibility_types", &self.enhanced_eligibility_types)?;
280        s.serialize_field("evidence", &self.evidence)?;
281        s.serialize_field("evidence_details", &self.evidence_details)?;
282        s.serialize_field("id", &self.id)?;
283        s.serialize_field("is_charge_refundable", &self.is_charge_refundable)?;
284        s.serialize_field("livemode", &self.livemode)?;
285        s.serialize_field("metadata", &self.metadata)?;
286        s.serialize_field("network_reason_code", &self.network_reason_code)?;
287        s.serialize_field("payment_intent", &self.payment_intent)?;
288        s.serialize_field("payment_method_details", &self.payment_method_details)?;
289        s.serialize_field("reason", &self.reason)?;
290        s.serialize_field("status", &self.status)?;
291
292        s.serialize_field("object", "dispute")?;
293        s.end()
294    }
295}
296/// List of eligibility types that are included in `enhanced_evidence`.
297#[derive(Copy, Clone, Eq, PartialEq)]
298pub enum DisputeEnhancedEligibilityTypes {
299    VisaCompellingEvidence3,
300    VisaCompliance,
301}
302impl DisputeEnhancedEligibilityTypes {
303    pub fn as_str(self) -> &'static str {
304        use DisputeEnhancedEligibilityTypes::*;
305        match self {
306            VisaCompellingEvidence3 => "visa_compelling_evidence_3",
307            VisaCompliance => "visa_compliance",
308        }
309    }
310}
311
312impl std::str::FromStr for DisputeEnhancedEligibilityTypes {
313    type Err = stripe_types::StripeParseError;
314    fn from_str(s: &str) -> Result<Self, Self::Err> {
315        use DisputeEnhancedEligibilityTypes::*;
316        match s {
317            "visa_compelling_evidence_3" => Ok(VisaCompellingEvidence3),
318            "visa_compliance" => Ok(VisaCompliance),
319            _ => Err(stripe_types::StripeParseError),
320        }
321    }
322}
323impl std::fmt::Display for DisputeEnhancedEligibilityTypes {
324    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
325        f.write_str(self.as_str())
326    }
327}
328
329impl std::fmt::Debug for DisputeEnhancedEligibilityTypes {
330    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
331        f.write_str(self.as_str())
332    }
333}
334#[cfg(feature = "serialize")]
335impl serde::Serialize for DisputeEnhancedEligibilityTypes {
336    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
337    where
338        S: serde::Serializer,
339    {
340        serializer.serialize_str(self.as_str())
341    }
342}
343impl miniserde::Deserialize for DisputeEnhancedEligibilityTypes {
344    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
345        crate::Place::new(out)
346    }
347}
348
349impl miniserde::de::Visitor for crate::Place<DisputeEnhancedEligibilityTypes> {
350    fn string(&mut self, s: &str) -> miniserde::Result<()> {
351        use std::str::FromStr;
352        self.out =
353            Some(DisputeEnhancedEligibilityTypes::from_str(s).map_err(|_| miniserde::Error)?);
354        Ok(())
355    }
356}
357
358stripe_types::impl_from_val_with_from_str!(DisputeEnhancedEligibilityTypes);
359#[cfg(feature = "deserialize")]
360impl<'de> serde::Deserialize<'de> for DisputeEnhancedEligibilityTypes {
361    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
362        use std::str::FromStr;
363        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
364        Self::from_str(&s).map_err(|_| {
365            serde::de::Error::custom("Unknown value for DisputeEnhancedEligibilityTypes")
366        })
367    }
368}
369/// The current status of a dispute.
370/// Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
371#[derive(Copy, Clone, Eq, PartialEq)]
372pub enum DisputeStatus {
373    Lost,
374    NeedsResponse,
375    UnderReview,
376    WarningClosed,
377    WarningNeedsResponse,
378    WarningUnderReview,
379    Won,
380}
381impl DisputeStatus {
382    pub fn as_str(self) -> &'static str {
383        use DisputeStatus::*;
384        match self {
385            Lost => "lost",
386            NeedsResponse => "needs_response",
387            UnderReview => "under_review",
388            WarningClosed => "warning_closed",
389            WarningNeedsResponse => "warning_needs_response",
390            WarningUnderReview => "warning_under_review",
391            Won => "won",
392        }
393    }
394}
395
396impl std::str::FromStr for DisputeStatus {
397    type Err = stripe_types::StripeParseError;
398    fn from_str(s: &str) -> Result<Self, Self::Err> {
399        use DisputeStatus::*;
400        match s {
401            "lost" => Ok(Lost),
402            "needs_response" => Ok(NeedsResponse),
403            "under_review" => Ok(UnderReview),
404            "warning_closed" => Ok(WarningClosed),
405            "warning_needs_response" => Ok(WarningNeedsResponse),
406            "warning_under_review" => Ok(WarningUnderReview),
407            "won" => Ok(Won),
408            _ => Err(stripe_types::StripeParseError),
409        }
410    }
411}
412impl std::fmt::Display for DisputeStatus {
413    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
414        f.write_str(self.as_str())
415    }
416}
417
418impl std::fmt::Debug for DisputeStatus {
419    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
420        f.write_str(self.as_str())
421    }
422}
423#[cfg(feature = "serialize")]
424impl serde::Serialize for DisputeStatus {
425    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
426    where
427        S: serde::Serializer,
428    {
429        serializer.serialize_str(self.as_str())
430    }
431}
432impl miniserde::Deserialize for DisputeStatus {
433    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
434        crate::Place::new(out)
435    }
436}
437
438impl miniserde::de::Visitor for crate::Place<DisputeStatus> {
439    fn string(&mut self, s: &str) -> miniserde::Result<()> {
440        use std::str::FromStr;
441        self.out = Some(DisputeStatus::from_str(s).map_err(|_| miniserde::Error)?);
442        Ok(())
443    }
444}
445
446stripe_types::impl_from_val_with_from_str!(DisputeStatus);
447#[cfg(feature = "deserialize")]
448impl<'de> serde::Deserialize<'de> for DisputeStatus {
449    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
450        use std::str::FromStr;
451        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
452        Self::from_str(&s).map_err(|_| serde::de::Error::custom("Unknown value for DisputeStatus"))
453    }
454}
455impl stripe_types::Object for Dispute {
456    type Id = stripe_shared::DisputeId;
457    fn id(&self) -> &Self::Id {
458        &self.id
459    }
460
461    fn into_id(self) -> Self::Id {
462        self.id
463    }
464}
465stripe_types::def_id!(DisputeId);
stripe_shared/dispute.rs

stripe_shared/
dispute.rs
