stripe_shared/
payment_method_card_present.rs

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

stripe_shared/
payment_method_card_present.rs
