stripe_shared/
payment_method_interac_present.rs

1#[derive(Clone, Debug)]
2#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
3#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
4pub struct PaymentMethodInteracPresent {
5    /// Card brand. Can be `interac`, `mastercard` or `visa`.
6    pub brand: Option<String>,
7    /// The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format.
8    /// May include alphanumeric characters, special characters and first/last name separator (`/`).
9    /// In some cases, the cardholder name may not be available depending on how the issuer has configured the card.
10    /// Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
11    pub cardholder_name: Option<String>,
12    /// Two-letter ISO code representing the country of the card.
13    /// You could use this attribute to get a sense of the international breakdown of cards you've collected.
14    pub country: Option<String>,
15    /// A high-level description of the type of cards issued in this range.
16    /// (For internal use only and not typically available in standard API requests.).
17    pub description: Option<String>,
18    /// Two-digit number representing the card's expiration month.
19    pub exp_month: i64,
20    /// Four-digit number representing the card's expiration year.
21    pub exp_year: i64,
22    /// Uniquely identifies this particular card number.
23    /// You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example.
24    /// For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
25    ///
26    /// *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.*.
27    pub fingerprint: Option<String>,
28    /// Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
29    pub funding: Option<String>,
30    /// Issuer identification number of the card.
31    /// (For internal use only and not typically available in standard API requests.).
32    pub iin: Option<String>,
33    /// The name of the card's issuing bank.
34    /// (For internal use only and not typically available in standard API requests.).
35    pub issuer: Option<String>,
36    /// The last four digits of the card.
37    pub last4: Option<String>,
38    /// Contains information about card networks that can be used to process the payment.
39    pub networks: Option<stripe_shared::PaymentMethodCardPresentNetworks>,
40    /// The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card.
41    /// Referenced from EMV tag 5F2D, data encoded on the card's chip.
42    pub preferred_locales: Option<Vec<String>>,
43    /// How card details were read in this transaction.
44    pub read_method: Option<PaymentMethodInteracPresentReadMethod>,
45}
46#[doc(hidden)]
47pub struct PaymentMethodInteracPresentBuilder {
48    brand: Option<Option<String>>,
49    cardholder_name: Option<Option<String>>,
50    country: Option<Option<String>>,
51    description: Option<Option<String>>,
52    exp_month: Option<i64>,
53    exp_year: Option<i64>,
54    fingerprint: Option<Option<String>>,
55    funding: Option<Option<String>>,
56    iin: Option<Option<String>>,
57    issuer: Option<Option<String>>,
58    last4: Option<Option<String>>,
59    networks: Option<Option<stripe_shared::PaymentMethodCardPresentNetworks>>,
60    preferred_locales: Option<Option<Vec<String>>>,
61    read_method: Option<Option<PaymentMethodInteracPresentReadMethod>>,
62}
63
64#[allow(
65    unused_variables,
66    irrefutable_let_patterns,
67    clippy::let_unit_value,
68    clippy::match_single_binding,
69    clippy::single_match
70)]
71const _: () = {
72    use miniserde::de::{Map, Visitor};
73    use miniserde::json::Value;
74    use miniserde::{Deserialize, Result, make_place};
75    use stripe_types::miniserde_helpers::FromValueOpt;
76    use stripe_types::{MapBuilder, ObjectDeser};
77
78    make_place!(Place);
79
80    impl Deserialize for PaymentMethodInteracPresent {
81        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
82            Place::new(out)
83        }
84    }
85
86    struct Builder<'a> {
87        out: &'a mut Option<PaymentMethodInteracPresent>,
88        builder: PaymentMethodInteracPresentBuilder,
89    }
90
91    impl Visitor for Place<PaymentMethodInteracPresent> {
92        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
93            Ok(Box::new(Builder {
94                out: &mut self.out,
95                builder: PaymentMethodInteracPresentBuilder::deser_default(),
96            }))
97        }
98    }
99
100    impl MapBuilder for PaymentMethodInteracPresentBuilder {
101        type Out = PaymentMethodInteracPresent;
102        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
103            Ok(match k {
104                "brand" => Deserialize::begin(&mut self.brand),
105                "cardholder_name" => Deserialize::begin(&mut self.cardholder_name),
106                "country" => Deserialize::begin(&mut self.country),
107                "description" => Deserialize::begin(&mut self.description),
108                "exp_month" => Deserialize::begin(&mut self.exp_month),
109                "exp_year" => Deserialize::begin(&mut self.exp_year),
110                "fingerprint" => Deserialize::begin(&mut self.fingerprint),
111                "funding" => Deserialize::begin(&mut self.funding),
112                "iin" => Deserialize::begin(&mut self.iin),
113                "issuer" => Deserialize::begin(&mut self.issuer),
114                "last4" => Deserialize::begin(&mut self.last4),
115                "networks" => Deserialize::begin(&mut self.networks),
116                "preferred_locales" => Deserialize::begin(&mut self.preferred_locales),
117                "read_method" => Deserialize::begin(&mut self.read_method),
118                _ => <dyn Visitor>::ignore(),
119            })
120        }
121
122        fn deser_default() -> Self {
123            Self {
124                brand: Deserialize::default(),
125                cardholder_name: Deserialize::default(),
126                country: Deserialize::default(),
127                description: Deserialize::default(),
128                exp_month: Deserialize::default(),
129                exp_year: Deserialize::default(),
130                fingerprint: Deserialize::default(),
131                funding: Deserialize::default(),
132                iin: Deserialize::default(),
133                issuer: Deserialize::default(),
134                last4: Deserialize::default(),
135                networks: Deserialize::default(),
136                preferred_locales: Deserialize::default(),
137                read_method: Deserialize::default(),
138            }
139        }
140
141        fn take_out(&mut self) -> Option<Self::Out> {
142            let (
143                Some(brand),
144                Some(cardholder_name),
145                Some(country),
146                Some(description),
147                Some(exp_month),
148                Some(exp_year),
149                Some(fingerprint),
150                Some(funding),
151                Some(iin),
152                Some(issuer),
153                Some(last4),
154                Some(networks),
155                Some(preferred_locales),
156                Some(read_method),
157            ) = (
158                self.brand.take(),
159                self.cardholder_name.take(),
160                self.country.take(),
161                self.description.take(),
162                self.exp_month,
163                self.exp_year,
164                self.fingerprint.take(),
165                self.funding.take(),
166                self.iin.take(),
167                self.issuer.take(),
168                self.last4.take(),
169                self.networks.take(),
170                self.preferred_locales.take(),
171                self.read_method,
172            )
173            else {
174                return None;
175            };
176            Some(Self::Out {
177                brand,
178                cardholder_name,
179                country,
180                description,
181                exp_month,
182                exp_year,
183                fingerprint,
184                funding,
185                iin,
186                issuer,
187                last4,
188                networks,
189                preferred_locales,
190                read_method,
191            })
192        }
193    }
194
195    impl Map for Builder<'_> {
196        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
197            self.builder.key(k)
198        }
199
200        fn finish(&mut self) -> Result<()> {
201            *self.out = self.builder.take_out();
202            Ok(())
203        }
204    }
205
206    impl ObjectDeser for PaymentMethodInteracPresent {
207        type Builder = PaymentMethodInteracPresentBuilder;
208    }
209
210    impl FromValueOpt for PaymentMethodInteracPresent {
211        fn from_value(v: Value) -> Option<Self> {
212            let Value::Object(obj) = v else {
213                return None;
214            };
215            let mut b = PaymentMethodInteracPresentBuilder::deser_default();
216            for (k, v) in obj {
217                match k.as_str() {
218                    "brand" => b.brand = FromValueOpt::from_value(v),
219                    "cardholder_name" => b.cardholder_name = FromValueOpt::from_value(v),
220                    "country" => b.country = FromValueOpt::from_value(v),
221                    "description" => b.description = FromValueOpt::from_value(v),
222                    "exp_month" => b.exp_month = FromValueOpt::from_value(v),
223                    "exp_year" => b.exp_year = FromValueOpt::from_value(v),
224                    "fingerprint" => b.fingerprint = FromValueOpt::from_value(v),
225                    "funding" => b.funding = FromValueOpt::from_value(v),
226                    "iin" => b.iin = FromValueOpt::from_value(v),
227                    "issuer" => b.issuer = FromValueOpt::from_value(v),
228                    "last4" => b.last4 = FromValueOpt::from_value(v),
229                    "networks" => b.networks = FromValueOpt::from_value(v),
230                    "preferred_locales" => b.preferred_locales = FromValueOpt::from_value(v),
231                    "read_method" => b.read_method = FromValueOpt::from_value(v),
232                    _ => {}
233                }
234            }
235            b.take_out()
236        }
237    }
238};
239/// How card details were read in this transaction.
240#[derive(Copy, Clone, Eq, PartialEq)]
241pub enum PaymentMethodInteracPresentReadMethod {
242    ContactEmv,
243    ContactlessEmv,
244    ContactlessMagstripeMode,
245    MagneticStripeFallback,
246    MagneticStripeTrack2,
247}
248impl PaymentMethodInteracPresentReadMethod {
249    pub fn as_str(self) -> &'static str {
250        use PaymentMethodInteracPresentReadMethod::*;
251        match self {
252            ContactEmv => "contact_emv",
253            ContactlessEmv => "contactless_emv",
254            ContactlessMagstripeMode => "contactless_magstripe_mode",
255            MagneticStripeFallback => "magnetic_stripe_fallback",
256            MagneticStripeTrack2 => "magnetic_stripe_track2",
257        }
258    }
259}
260
261impl std::str::FromStr for PaymentMethodInteracPresentReadMethod {
262    type Err = stripe_types::StripeParseError;
263    fn from_str(s: &str) -> Result<Self, Self::Err> {
264        use PaymentMethodInteracPresentReadMethod::*;
265        match s {
266            "contact_emv" => Ok(ContactEmv),
267            "contactless_emv" => Ok(ContactlessEmv),
268            "contactless_magstripe_mode" => Ok(ContactlessMagstripeMode),
269            "magnetic_stripe_fallback" => Ok(MagneticStripeFallback),
270            "magnetic_stripe_track2" => Ok(MagneticStripeTrack2),
271            _ => Err(stripe_types::StripeParseError),
272        }
273    }
274}
275impl std::fmt::Display for PaymentMethodInteracPresentReadMethod {
276    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
277        f.write_str(self.as_str())
278    }
279}
280
281impl std::fmt::Debug for PaymentMethodInteracPresentReadMethod {
282    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
283        f.write_str(self.as_str())
284    }
285}
286#[cfg(feature = "serialize")]
287impl serde::Serialize for PaymentMethodInteracPresentReadMethod {
288    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
289    where
290        S: serde::Serializer,
291    {
292        serializer.serialize_str(self.as_str())
293    }
294}
295impl miniserde::Deserialize for PaymentMethodInteracPresentReadMethod {
296    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
297        crate::Place::new(out)
298    }
299}
300
301impl miniserde::de::Visitor for crate::Place<PaymentMethodInteracPresentReadMethod> {
302    fn string(&mut self, s: &str) -> miniserde::Result<()> {
303        use std::str::FromStr;
304        self.out =
305            Some(PaymentMethodInteracPresentReadMethod::from_str(s).map_err(|_| miniserde::Error)?);
306        Ok(())
307    }
308}
309
310stripe_types::impl_from_val_with_from_str!(PaymentMethodInteracPresentReadMethod);
311#[cfg(feature = "deserialize")]
312impl<'de> serde::Deserialize<'de> for PaymentMethodInteracPresentReadMethod {
313    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
314        use std::str::FromStr;
315        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
316        Self::from_str(&s).map_err(|_| {
317            serde::de::Error::custom("Unknown value for PaymentMethodInteracPresentReadMethod")
318        })
319    }
320}
stripe_shared/payment_method_interac_present.rs

stripe_shared/
payment_method_interac_present.rs
