stripe_shared/
payment_method_card.rs

1#[derive(Clone, Debug)]
2#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
3#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
4pub struct PaymentMethodCard {
5    /// Card brand.
6    /// Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
7    pub brand: String,
8    /// Checks on Card address and CVC if provided.
9    pub checks: Option<stripe_shared::PaymentMethodCardChecks>,
10    /// Two-letter ISO code representing the country of the card.
11    /// You could use this attribute to get a sense of the international breakdown of cards you've collected.
12    pub country: Option<String>,
13    /// A high-level description of the type of cards issued in this range.
14    /// (For internal use only and not typically available in standard API requests.).
15    pub description: Option<String>,
16    /// The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards.
17    /// Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.
18    pub display_brand: Option<String>,
19    /// Two-digit number representing the card's expiration month.
20    pub exp_month: i64,
21    /// Four-digit number representing the card's expiration year.
22    pub exp_year: i64,
23    /// Uniquely identifies this particular card number.
24    /// You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example.
25    /// For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
26    ///
27    /// *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*.
28    pub fingerprint: Option<String>,
29    /// Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
30    pub funding: String,
31    /// Details of the original PaymentMethod that created this object.
32    pub generated_from: Option<stripe_shared::PaymentMethodCardGeneratedCard>,
33    /// Issuer identification number of the card.
34    /// (For internal use only and not typically available in standard API requests.).
35    pub iin: Option<String>,
36    /// The name of the card's issuing bank.
37    /// (For internal use only and not typically available in standard API requests.).
38    pub issuer: Option<String>,
39    /// The last four digits of the card.
40    pub last4: String,
41    /// Contains information about card networks that can be used to process the payment.
42    pub networks: Option<stripe_shared::Networks>,
43    /// Status of a card based on the card issuer.
44    pub regulated_status: Option<PaymentMethodCardRegulatedStatus>,
45    /// Contains details on how this Card may be used for 3D Secure authentication.
46    pub three_d_secure_usage: Option<stripe_shared::ThreeDSecureUsage>,
47    /// If this Card is part of a card wallet, this contains the details of the card wallet.
48    pub wallet: Option<stripe_shared::PaymentMethodCardWallet>,
49}
50#[doc(hidden)]
51pub struct PaymentMethodCardBuilder {
52    brand: Option<String>,
53    checks: Option<Option<stripe_shared::PaymentMethodCardChecks>>,
54    country: Option<Option<String>>,
55    description: Option<Option<String>>,
56    display_brand: Option<Option<String>>,
57    exp_month: Option<i64>,
58    exp_year: Option<i64>,
59    fingerprint: Option<Option<String>>,
60    funding: Option<String>,
61    generated_from: Option<Option<stripe_shared::PaymentMethodCardGeneratedCard>>,
62    iin: Option<Option<String>>,
63    issuer: Option<Option<String>>,
64    last4: Option<String>,
65    networks: Option<Option<stripe_shared::Networks>>,
66    regulated_status: Option<Option<PaymentMethodCardRegulatedStatus>>,
67    three_d_secure_usage: Option<Option<stripe_shared::ThreeDSecureUsage>>,
68    wallet: Option<Option<stripe_shared::PaymentMethodCardWallet>>,
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::{Deserialize, Result, make_place};
82    use stripe_types::miniserde_helpers::FromValueOpt;
83    use stripe_types::{MapBuilder, ObjectDeser};
84
85    make_place!(Place);
86
87    impl Deserialize for PaymentMethodCard {
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<PaymentMethodCard>,
95        builder: PaymentMethodCardBuilder,
96    }
97
98    impl Visitor for Place<PaymentMethodCard> {
99        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
100            Ok(Box::new(Builder {
101                out: &mut self.out,
102                builder: PaymentMethodCardBuilder::deser_default(),
103            }))
104        }
105    }
106
107    impl MapBuilder for PaymentMethodCardBuilder {
108        type Out = PaymentMethodCard;
109        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
110            Ok(match k {
111                "brand" => Deserialize::begin(&mut self.brand),
112                "checks" => Deserialize::begin(&mut self.checks),
113                "country" => Deserialize::begin(&mut self.country),
114                "description" => Deserialize::begin(&mut self.description),
115                "display_brand" => Deserialize::begin(&mut self.display_brand),
116                "exp_month" => Deserialize::begin(&mut self.exp_month),
117                "exp_year" => Deserialize::begin(&mut self.exp_year),
118                "fingerprint" => Deserialize::begin(&mut self.fingerprint),
119                "funding" => Deserialize::begin(&mut self.funding),
120                "generated_from" => Deserialize::begin(&mut self.generated_from),
121                "iin" => Deserialize::begin(&mut self.iin),
122                "issuer" => Deserialize::begin(&mut self.issuer),
123                "last4" => Deserialize::begin(&mut self.last4),
124                "networks" => Deserialize::begin(&mut self.networks),
125                "regulated_status" => Deserialize::begin(&mut self.regulated_status),
126                "three_d_secure_usage" => Deserialize::begin(&mut self.three_d_secure_usage),
127                "wallet" => Deserialize::begin(&mut self.wallet),
128                _ => <dyn Visitor>::ignore(),
129            })
130        }
131
132        fn deser_default() -> Self {
133            Self {
134                brand: Deserialize::default(),
135                checks: Deserialize::default(),
136                country: Deserialize::default(),
137                description: Deserialize::default(),
138                display_brand: Deserialize::default(),
139                exp_month: Deserialize::default(),
140                exp_year: Deserialize::default(),
141                fingerprint: Deserialize::default(),
142                funding: Deserialize::default(),
143                generated_from: Deserialize::default(),
144                iin: Deserialize::default(),
145                issuer: Deserialize::default(),
146                last4: Deserialize::default(),
147                networks: Deserialize::default(),
148                regulated_status: Deserialize::default(),
149                three_d_secure_usage: Deserialize::default(),
150                wallet: Deserialize::default(),
151            }
152        }
153
154        fn take_out(&mut self) -> Option<Self::Out> {
155            let (
156                Some(brand),
157                Some(checks),
158                Some(country),
159                Some(description),
160                Some(display_brand),
161                Some(exp_month),
162                Some(exp_year),
163                Some(fingerprint),
164                Some(funding),
165                Some(generated_from),
166                Some(iin),
167                Some(issuer),
168                Some(last4),
169                Some(networks),
170                Some(regulated_status),
171                Some(three_d_secure_usage),
172                Some(wallet),
173            ) = (
174                self.brand.take(),
175                self.checks.take(),
176                self.country.take(),
177                self.description.take(),
178                self.display_brand.take(),
179                self.exp_month,
180                self.exp_year,
181                self.fingerprint.take(),
182                self.funding.take(),
183                self.generated_from.take(),
184                self.iin.take(),
185                self.issuer.take(),
186                self.last4.take(),
187                self.networks.take(),
188                self.regulated_status,
189                self.three_d_secure_usage,
190                self.wallet.take(),
191            )
192            else {
193                return None;
194            };
195            Some(Self::Out {
196                brand,
197                checks,
198                country,
199                description,
200                display_brand,
201                exp_month,
202                exp_year,
203                fingerprint,
204                funding,
205                generated_from,
206                iin,
207                issuer,
208                last4,
209                networks,
210                regulated_status,
211                three_d_secure_usage,
212                wallet,
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 PaymentMethodCard {
229        type Builder = PaymentMethodCardBuilder;
230    }
231
232    impl FromValueOpt for PaymentMethodCard {
233        fn from_value(v: Value) -> Option<Self> {
234            let Value::Object(obj) = v else {
235                return None;
236            };
237            let mut b = PaymentMethodCardBuilder::deser_default();
238            for (k, v) in obj {
239                match k.as_str() {
240                    "brand" => b.brand = FromValueOpt::from_value(v),
241                    "checks" => b.checks = FromValueOpt::from_value(v),
242                    "country" => b.country = FromValueOpt::from_value(v),
243                    "description" => b.description = FromValueOpt::from_value(v),
244                    "display_brand" => b.display_brand = FromValueOpt::from_value(v),
245                    "exp_month" => b.exp_month = FromValueOpt::from_value(v),
246                    "exp_year" => b.exp_year = FromValueOpt::from_value(v),
247                    "fingerprint" => b.fingerprint = FromValueOpt::from_value(v),
248                    "funding" => b.funding = FromValueOpt::from_value(v),
249                    "generated_from" => b.generated_from = FromValueOpt::from_value(v),
250                    "iin" => b.iin = FromValueOpt::from_value(v),
251                    "issuer" => b.issuer = FromValueOpt::from_value(v),
252                    "last4" => b.last4 = FromValueOpt::from_value(v),
253                    "networks" => b.networks = FromValueOpt::from_value(v),
254                    "regulated_status" => b.regulated_status = FromValueOpt::from_value(v),
255                    "three_d_secure_usage" => b.three_d_secure_usage = FromValueOpt::from_value(v),
256                    "wallet" => b.wallet = FromValueOpt::from_value(v),
257                    _ => {}
258                }
259            }
260            b.take_out()
261        }
262    }
263};
264/// Status of a card based on the card issuer.
265#[derive(Copy, Clone, Eq, PartialEq)]
266pub enum PaymentMethodCardRegulatedStatus {
267    Regulated,
268    Unregulated,
269}
270impl PaymentMethodCardRegulatedStatus {
271    pub fn as_str(self) -> &'static str {
272        use PaymentMethodCardRegulatedStatus::*;
273        match self {
274            Regulated => "regulated",
275            Unregulated => "unregulated",
276        }
277    }
278}
279
280impl std::str::FromStr for PaymentMethodCardRegulatedStatus {
281    type Err = stripe_types::StripeParseError;
282    fn from_str(s: &str) -> Result<Self, Self::Err> {
283        use PaymentMethodCardRegulatedStatus::*;
284        match s {
285            "regulated" => Ok(Regulated),
286            "unregulated" => Ok(Unregulated),
287            _ => Err(stripe_types::StripeParseError),
288        }
289    }
290}
291impl std::fmt::Display for PaymentMethodCardRegulatedStatus {
292    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
293        f.write_str(self.as_str())
294    }
295}
296
297impl std::fmt::Debug for PaymentMethodCardRegulatedStatus {
298    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
299        f.write_str(self.as_str())
300    }
301}
302#[cfg(feature = "serialize")]
303impl serde::Serialize for PaymentMethodCardRegulatedStatus {
304    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
305    where
306        S: serde::Serializer,
307    {
308        serializer.serialize_str(self.as_str())
309    }
310}
311impl miniserde::Deserialize for PaymentMethodCardRegulatedStatus {
312    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
313        crate::Place::new(out)
314    }
315}
316
317impl miniserde::de::Visitor for crate::Place<PaymentMethodCardRegulatedStatus> {
318    fn string(&mut self, s: &str) -> miniserde::Result<()> {
319        use std::str::FromStr;
320        self.out =
321            Some(PaymentMethodCardRegulatedStatus::from_str(s).map_err(|_| miniserde::Error)?);
322        Ok(())
323    }
324}
325
326stripe_types::impl_from_val_with_from_str!(PaymentMethodCardRegulatedStatus);
327#[cfg(feature = "deserialize")]
328impl<'de> serde::Deserialize<'de> for PaymentMethodCardRegulatedStatus {
329    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
330        use std::str::FromStr;
331        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
332        Self::from_str(&s).map_err(|_| {
333            serde::de::Error::custom("Unknown value for PaymentMethodCardRegulatedStatus")
334        })
335    }
336}