stripe_shared/
charge_outcome.rs

1#[derive(Clone)]
2#[cfg_attr(not(feature = "redact-generated-debug"), derive(Debug))]
3#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
4#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
5pub struct ChargeOutcome {
6    /// An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines).
7    pub advice_code: Option<ChargeOutcomeAdviceCode>,
8    /// For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.
9    pub network_advice_code: Option<String>,
10    /// For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.
11    pub network_decline_code: Option<String>,
12    /// Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`.
13    /// The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
14    pub network_status: Option<String>,
15    /// An enumerated value providing a more detailed explanation of the outcome's `type`.
16    /// Charges blocked by Radar's default block rule have the value `highest_risk_level`.
17    /// Charges placed in review by Radar's default review rule have the value `elevated_risk_level`.
18    /// Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`.
19    /// Charges authorized, blocked, or placed in review by custom rules have the value `rule`.
20    /// See [understanding declines](https://docs.stripe.com/declines) for more details.
21    pub reason: Option<String>,
22    /// Stripe Radar's evaluation of the riskiness of the payment.
23    /// Possible values for evaluated payments are `normal`, `elevated`, `highest`.
24    /// For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`.
25    /// In the event of an error in the evaluation, this field will have the value `unknown`.
26    /// This field is only available with Radar.
27    pub risk_level: Option<String>,
28    /// Stripe Radar's evaluation of the riskiness of the payment.
29    /// Possible values for evaluated payments are between 0 and 100.
30    /// 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.
31    /// This field is only available with Radar for Fraud Teams.
32    pub risk_score: Option<i64>,
33    /// The ID of the Radar rule that matched the payment, if applicable.
34    pub rule: Option<stripe_types::Expandable<stripe_shared::Rule>>,
35    /// A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
36    pub seller_message: Option<String>,
37    /// Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`.
38    /// See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details.
39    #[cfg_attr(any(feature = "deserialize", feature = "serialize"), serde(rename = "type"))]
40    pub type_: String,
41}
42#[cfg(feature = "redact-generated-debug")]
43impl std::fmt::Debug for ChargeOutcome {
44    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
45        f.debug_struct("ChargeOutcome").finish_non_exhaustive()
46    }
47}
48#[doc(hidden)]
49pub struct ChargeOutcomeBuilder {
50    advice_code: Option<Option<ChargeOutcomeAdviceCode>>,
51    network_advice_code: Option<Option<String>>,
52    network_decline_code: Option<Option<String>>,
53    network_status: Option<Option<String>>,
54    reason: Option<Option<String>>,
55    risk_level: Option<Option<String>>,
56    risk_score: Option<Option<i64>>,
57    rule: Option<Option<stripe_types::Expandable<stripe_shared::Rule>>>,
58    seller_message: Option<Option<String>>,
59    type_: Option<String>,
60}
61
62#[allow(
63    unused_variables,
64    irrefutable_let_patterns,
65    clippy::let_unit_value,
66    clippy::match_single_binding,
67    clippy::single_match
68)]
69const _: () = {
70    use miniserde::de::{Map, Visitor};
71    use miniserde::json::Value;
72    use miniserde::{Deserialize, Result, make_place};
73    use stripe_types::miniserde_helpers::FromValueOpt;
74    use stripe_types::{MapBuilder, ObjectDeser};
75
76    make_place!(Place);
77
78    impl Deserialize for ChargeOutcome {
79        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
80            Place::new(out)
81        }
82    }
83
84    struct Builder<'a> {
85        out: &'a mut Option<ChargeOutcome>,
86        builder: ChargeOutcomeBuilder,
87    }
88
89    impl Visitor for Place<ChargeOutcome> {
90        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
91            Ok(Box::new(Builder {
92                out: &mut self.out,
93                builder: ChargeOutcomeBuilder::deser_default(),
94            }))
95        }
96    }
97
98    impl MapBuilder for ChargeOutcomeBuilder {
99        type Out = ChargeOutcome;
100        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
101            Ok(match k {
102                "advice_code" => Deserialize::begin(&mut self.advice_code),
103                "network_advice_code" => Deserialize::begin(&mut self.network_advice_code),
104                "network_decline_code" => Deserialize::begin(&mut self.network_decline_code),
105                "network_status" => Deserialize::begin(&mut self.network_status),
106                "reason" => Deserialize::begin(&mut self.reason),
107                "risk_level" => Deserialize::begin(&mut self.risk_level),
108                "risk_score" => Deserialize::begin(&mut self.risk_score),
109                "rule" => Deserialize::begin(&mut self.rule),
110                "seller_message" => Deserialize::begin(&mut self.seller_message),
111                "type" => Deserialize::begin(&mut self.type_),
112                _ => <dyn Visitor>::ignore(),
113            })
114        }
115
116        fn deser_default() -> Self {
117            Self {
118                advice_code: Some(None),
119                network_advice_code: Some(None),
120                network_decline_code: Some(None),
121                network_status: Some(None),
122                reason: Some(None),
123                risk_level: Some(None),
124                risk_score: Some(None),
125                rule: Some(None),
126                seller_message: Some(None),
127                type_: None,
128            }
129        }
130
131        fn take_out(&mut self) -> Option<Self::Out> {
132            let (
133                Some(advice_code),
134                Some(network_advice_code),
135                Some(network_decline_code),
136                Some(network_status),
137                Some(reason),
138                Some(risk_level),
139                Some(risk_score),
140                Some(rule),
141                Some(seller_message),
142                Some(type_),
143            ) = (
144                self.advice_code.take(),
145                self.network_advice_code.take(),
146                self.network_decline_code.take(),
147                self.network_status.take(),
148                self.reason.take(),
149                self.risk_level.take(),
150                self.risk_score,
151                self.rule.take(),
152                self.seller_message.take(),
153                self.type_.take(),
154            )
155            else {
156                return None;
157            };
158            Some(Self::Out {
159                advice_code,
160                network_advice_code,
161                network_decline_code,
162                network_status,
163                reason,
164                risk_level,
165                risk_score,
166                rule,
167                seller_message,
168                type_,
169            })
170        }
171    }
172
173    impl Map for Builder<'_> {
174        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
175            self.builder.key(k)
176        }
177
178        fn finish(&mut self) -> Result<()> {
179            *self.out = self.builder.take_out();
180            Ok(())
181        }
182    }
183
184    impl ObjectDeser for ChargeOutcome {
185        type Builder = ChargeOutcomeBuilder;
186    }
187
188    impl FromValueOpt for ChargeOutcome {
189        fn from_value(v: Value) -> Option<Self> {
190            let Value::Object(obj) = v else {
191                return None;
192            };
193            let mut b = ChargeOutcomeBuilder::deser_default();
194            for (k, v) in obj {
195                match k.as_str() {
196                    "advice_code" => b.advice_code = FromValueOpt::from_value(v),
197                    "network_advice_code" => b.network_advice_code = FromValueOpt::from_value(v),
198                    "network_decline_code" => b.network_decline_code = FromValueOpt::from_value(v),
199                    "network_status" => b.network_status = FromValueOpt::from_value(v),
200                    "reason" => b.reason = FromValueOpt::from_value(v),
201                    "risk_level" => b.risk_level = FromValueOpt::from_value(v),
202                    "risk_score" => b.risk_score = FromValueOpt::from_value(v),
203                    "rule" => b.rule = FromValueOpt::from_value(v),
204                    "seller_message" => b.seller_message = FromValueOpt::from_value(v),
205                    "type" => b.type_ = FromValueOpt::from_value(v),
206                    _ => {}
207                }
208            }
209            b.take_out()
210        }
211    }
212};
213/// An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines).
214#[derive(Clone, Eq, PartialEq)]
215#[non_exhaustive]
216pub enum ChargeOutcomeAdviceCode {
217    ConfirmCardData,
218    DoNotTryAgain,
219    TryAgainLater,
220    /// An unrecognized value from Stripe. Should not be used as a request parameter.
221    Unknown(String),
222}
223impl ChargeOutcomeAdviceCode {
224    pub fn as_str(&self) -> &str {
225        use ChargeOutcomeAdviceCode::*;
226        match self {
227            ConfirmCardData => "confirm_card_data",
228            DoNotTryAgain => "do_not_try_again",
229            TryAgainLater => "try_again_later",
230            Unknown(v) => v,
231        }
232    }
233}
234
235impl std::str::FromStr for ChargeOutcomeAdviceCode {
236    type Err = std::convert::Infallible;
237    fn from_str(s: &str) -> Result<Self, Self::Err> {
238        use ChargeOutcomeAdviceCode::*;
239        match s {
240            "confirm_card_data" => Ok(ConfirmCardData),
241            "do_not_try_again" => Ok(DoNotTryAgain),
242            "try_again_later" => Ok(TryAgainLater),
243            v => {
244                tracing::warn!("Unknown value '{}' for enum '{}'", v, "ChargeOutcomeAdviceCode");
245                Ok(Unknown(v.to_owned()))
246            }
247        }
248    }
249}
250impl std::fmt::Display for ChargeOutcomeAdviceCode {
251    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
252        f.write_str(self.as_str())
253    }
254}
255
256#[cfg(not(feature = "redact-generated-debug"))]
257impl std::fmt::Debug for ChargeOutcomeAdviceCode {
258    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
259        f.write_str(self.as_str())
260    }
261}
262#[cfg(feature = "redact-generated-debug")]
263impl std::fmt::Debug for ChargeOutcomeAdviceCode {
264    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
265        f.debug_struct(stringify!(ChargeOutcomeAdviceCode)).finish_non_exhaustive()
266    }
267}
268#[cfg(feature = "serialize")]
269impl serde::Serialize for ChargeOutcomeAdviceCode {
270    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
271    where
272        S: serde::Serializer,
273    {
274        serializer.serialize_str(self.as_str())
275    }
276}
277impl miniserde::Deserialize for ChargeOutcomeAdviceCode {
278    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
279        crate::Place::new(out)
280    }
281}
282
283impl miniserde::de::Visitor for crate::Place<ChargeOutcomeAdviceCode> {
284    fn string(&mut self, s: &str) -> miniserde::Result<()> {
285        use std::str::FromStr;
286        self.out = Some(ChargeOutcomeAdviceCode::from_str(s).expect("infallible"));
287        Ok(())
288    }
289}
290
291stripe_types::impl_from_val_with_from_str!(ChargeOutcomeAdviceCode);
292#[cfg(feature = "deserialize")]
293impl<'de> serde::Deserialize<'de> for ChargeOutcomeAdviceCode {
294    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
295        use std::str::FromStr;
296        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
297        Ok(Self::from_str(&s).expect("infallible"))
298    }
299}
stripe_shared/charge_outcome.rs

stripe_shared/
charge_outcome.rs
