stripe_shared/
topup.rs

1/// To top up your Stripe balance, you create a top-up object. You can retrieve
2/// individual top-ups, as well as list all top-ups. Top-ups are identified by a
3/// unique, random ID.
4///
5/// Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)
6///
7/// For more details see <<https://stripe.com/docs/api/topups/object>>.
8#[derive(Clone, Debug)]
9#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
10pub struct Topup {
11    /// Amount transferred.
12    pub amount: i64,
13    /// ID of the balance transaction that describes the impact of this top-up on your account balance.
14    /// May not be specified depending on status of top-up.
15    pub balance_transaction: Option<stripe_types::Expandable<stripe_shared::BalanceTransaction>>,
16    /// Time at which the object was created. Measured in seconds since the Unix epoch.
17    pub created: stripe_types::Timestamp,
18    /// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
19    /// Must be a [supported currency](https://stripe.com/docs/currencies).
20    pub currency: stripe_types::Currency,
21    /// An arbitrary string attached to the object. Often useful for displaying to users.
22    pub description: Option<String>,
23    /// Date the funds are expected to arrive in your Stripe account for payouts.
24    /// This factors in delays like weekends or bank holidays.
25    /// May not be specified depending on status of top-up.
26    pub expected_availability_date: Option<stripe_types::Timestamp>,
27    /// Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).
28    pub failure_code: Option<String>,
29    /// Message to user further explaining reason for top-up failure if available.
30    pub failure_message: Option<String>,
31    /// Unique identifier for the object.
32    pub id: stripe_shared::TopupId,
33    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
34    pub livemode: bool,
35    /// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
36    /// This can be useful for storing additional information about the object in a structured format.
37    pub metadata: std::collections::HashMap<String, String>,
38    /// The source field is deprecated. It might not always be present in the API response.
39    pub source: Option<stripe_shared::Source>,
40    /// Extra information about a top-up.
41    /// This will appear on your source's bank statement.
42    /// It must contain at least one letter.
43    pub statement_descriptor: Option<String>,
44    /// The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
45    pub status: TopupStatus,
46    /// A string that identifies this top-up as part of a group.
47    pub transfer_group: Option<String>,
48}
49#[doc(hidden)]
50pub struct TopupBuilder {
51    amount: Option<i64>,
52    balance_transaction:
53        Option<Option<stripe_types::Expandable<stripe_shared::BalanceTransaction>>>,
54    created: Option<stripe_types::Timestamp>,
55    currency: Option<stripe_types::Currency>,
56    description: Option<Option<String>>,
57    expected_availability_date: Option<Option<stripe_types::Timestamp>>,
58    failure_code: Option<Option<String>>,
59    failure_message: Option<Option<String>>,
60    id: Option<stripe_shared::TopupId>,
61    livemode: Option<bool>,
62    metadata: Option<std::collections::HashMap<String, String>>,
63    source: Option<Option<stripe_shared::Source>>,
64    statement_descriptor: Option<Option<String>>,
65    status: Option<TopupStatus>,
66    transfer_group: Option<Option<String>>,
67}
68
69#[allow(
70    unused_variables,
71    irrefutable_let_patterns,
72    clippy::let_unit_value,
73    clippy::match_single_binding,
74    clippy::single_match
75)]
76const _: () = {
77    use miniserde::de::{Map, Visitor};
78    use miniserde::json::Value;
79    use miniserde::{make_place, Deserialize, Result};
80    use stripe_types::miniserde_helpers::FromValueOpt;
81    use stripe_types::{MapBuilder, ObjectDeser};
82
83    make_place!(Place);
84
85    impl Deserialize for Topup {
86        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
87            Place::new(out)
88        }
89    }
90
91    struct Builder<'a> {
92        out: &'a mut Option<Topup>,
93        builder: TopupBuilder,
94    }
95
96    impl Visitor for Place<Topup> {
97        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
98            Ok(Box::new(Builder { out: &mut self.out, builder: TopupBuilder::deser_default() }))
99        }
100    }
101
102    impl MapBuilder for TopupBuilder {
103        type Out = Topup;
104        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
105            Ok(match k {
106                "amount" => Deserialize::begin(&mut self.amount),
107                "balance_transaction" => Deserialize::begin(&mut self.balance_transaction),
108                "created" => Deserialize::begin(&mut self.created),
109                "currency" => Deserialize::begin(&mut self.currency),
110                "description" => Deserialize::begin(&mut self.description),
111                "expected_availability_date" => {
112                    Deserialize::begin(&mut self.expected_availability_date)
113                }
114                "failure_code" => Deserialize::begin(&mut self.failure_code),
115                "failure_message" => Deserialize::begin(&mut self.failure_message),
116                "id" => Deserialize::begin(&mut self.id),
117                "livemode" => Deserialize::begin(&mut self.livemode),
118                "metadata" => Deserialize::begin(&mut self.metadata),
119                "source" => Deserialize::begin(&mut self.source),
120                "statement_descriptor" => Deserialize::begin(&mut self.statement_descriptor),
121                "status" => Deserialize::begin(&mut self.status),
122                "transfer_group" => Deserialize::begin(&mut self.transfer_group),
123
124                _ => <dyn Visitor>::ignore(),
125            })
126        }
127
128        fn deser_default() -> Self {
129            Self {
130                amount: Deserialize::default(),
131                balance_transaction: Deserialize::default(),
132                created: Deserialize::default(),
133                currency: Deserialize::default(),
134                description: Deserialize::default(),
135                expected_availability_date: Deserialize::default(),
136                failure_code: Deserialize::default(),
137                failure_message: Deserialize::default(),
138                id: Deserialize::default(),
139                livemode: Deserialize::default(),
140                metadata: Deserialize::default(),
141                source: Deserialize::default(),
142                statement_descriptor: Deserialize::default(),
143                status: Deserialize::default(),
144                transfer_group: Deserialize::default(),
145            }
146        }
147
148        fn take_out(&mut self) -> Option<Self::Out> {
149            let (
150                Some(amount),
151                Some(balance_transaction),
152                Some(created),
153                Some(currency),
154                Some(description),
155                Some(expected_availability_date),
156                Some(failure_code),
157                Some(failure_message),
158                Some(id),
159                Some(livemode),
160                Some(metadata),
161                Some(source),
162                Some(statement_descriptor),
163                Some(status),
164                Some(transfer_group),
165            ) = (
166                self.amount,
167                self.balance_transaction.take(),
168                self.created,
169                self.currency,
170                self.description.take(),
171                self.expected_availability_date,
172                self.failure_code.take(),
173                self.failure_message.take(),
174                self.id.take(),
175                self.livemode,
176                self.metadata.take(),
177                self.source.take(),
178                self.statement_descriptor.take(),
179                self.status,
180                self.transfer_group.take(),
181            )
182            else {
183                return None;
184            };
185            Some(Self::Out {
186                amount,
187                balance_transaction,
188                created,
189                currency,
190                description,
191                expected_availability_date,
192                failure_code,
193                failure_message,
194                id,
195                livemode,
196                metadata,
197                source,
198                statement_descriptor,
199                status,
200                transfer_group,
201            })
202        }
203    }
204
205    impl<'a> Map for Builder<'a> {
206        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
207            self.builder.key(k)
208        }
209
210        fn finish(&mut self) -> Result<()> {
211            *self.out = self.builder.take_out();
212            Ok(())
213        }
214    }
215
216    impl ObjectDeser for Topup {
217        type Builder = TopupBuilder;
218    }
219
220    impl FromValueOpt for Topup {
221        fn from_value(v: Value) -> Option<Self> {
222            let Value::Object(obj) = v else {
223                return None;
224            };
225            let mut b = TopupBuilder::deser_default();
226            for (k, v) in obj {
227                match k.as_str() {
228                    "amount" => b.amount = FromValueOpt::from_value(v),
229                    "balance_transaction" => b.balance_transaction = FromValueOpt::from_value(v),
230                    "created" => b.created = FromValueOpt::from_value(v),
231                    "currency" => b.currency = FromValueOpt::from_value(v),
232                    "description" => b.description = FromValueOpt::from_value(v),
233                    "expected_availability_date" => {
234                        b.expected_availability_date = FromValueOpt::from_value(v)
235                    }
236                    "failure_code" => b.failure_code = FromValueOpt::from_value(v),
237                    "failure_message" => b.failure_message = FromValueOpt::from_value(v),
238                    "id" => b.id = FromValueOpt::from_value(v),
239                    "livemode" => b.livemode = FromValueOpt::from_value(v),
240                    "metadata" => b.metadata = FromValueOpt::from_value(v),
241                    "source" => b.source = FromValueOpt::from_value(v),
242                    "statement_descriptor" => b.statement_descriptor = FromValueOpt::from_value(v),
243                    "status" => b.status = FromValueOpt::from_value(v),
244                    "transfer_group" => b.transfer_group = FromValueOpt::from_value(v),
245
246                    _ => {}
247                }
248            }
249            b.take_out()
250        }
251    }
252};
253#[cfg(feature = "serialize")]
254impl serde::Serialize for Topup {
255    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
256        use serde::ser::SerializeStruct;
257        let mut s = s.serialize_struct("Topup", 16)?;
258        s.serialize_field("amount", &self.amount)?;
259        s.serialize_field("balance_transaction", &self.balance_transaction)?;
260        s.serialize_field("created", &self.created)?;
261        s.serialize_field("currency", &self.currency)?;
262        s.serialize_field("description", &self.description)?;
263        s.serialize_field("expected_availability_date", &self.expected_availability_date)?;
264        s.serialize_field("failure_code", &self.failure_code)?;
265        s.serialize_field("failure_message", &self.failure_message)?;
266        s.serialize_field("id", &self.id)?;
267        s.serialize_field("livemode", &self.livemode)?;
268        s.serialize_field("metadata", &self.metadata)?;
269        s.serialize_field("source", &self.source)?;
270        s.serialize_field("statement_descriptor", &self.statement_descriptor)?;
271        s.serialize_field("status", &self.status)?;
272        s.serialize_field("transfer_group", &self.transfer_group)?;
273
274        s.serialize_field("object", "topup")?;
275        s.end()
276    }
277}
278/// The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
279#[derive(Copy, Clone, Eq, PartialEq)]
280pub enum TopupStatus {
281    Canceled,
282    Failed,
283    Pending,
284    Reversed,
285    Succeeded,
286}
287impl TopupStatus {
288    pub fn as_str(self) -> &'static str {
289        use TopupStatus::*;
290        match self {
291            Canceled => "canceled",
292            Failed => "failed",
293            Pending => "pending",
294            Reversed => "reversed",
295            Succeeded => "succeeded",
296        }
297    }
298}
299
300impl std::str::FromStr for TopupStatus {
301    type Err = stripe_types::StripeParseError;
302    fn from_str(s: &str) -> Result<Self, Self::Err> {
303        use TopupStatus::*;
304        match s {
305            "canceled" => Ok(Canceled),
306            "failed" => Ok(Failed),
307            "pending" => Ok(Pending),
308            "reversed" => Ok(Reversed),
309            "succeeded" => Ok(Succeeded),
310            _ => Err(stripe_types::StripeParseError),
311        }
312    }
313}
314impl std::fmt::Display for TopupStatus {
315    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
316        f.write_str(self.as_str())
317    }
318}
319
320impl std::fmt::Debug for TopupStatus {
321    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
322        f.write_str(self.as_str())
323    }
324}
325#[cfg(feature = "serialize")]
326impl serde::Serialize for TopupStatus {
327    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
328    where
329        S: serde::Serializer,
330    {
331        serializer.serialize_str(self.as_str())
332    }
333}
334impl miniserde::Deserialize for TopupStatus {
335    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
336        crate::Place::new(out)
337    }
338}
339
340impl miniserde::de::Visitor for crate::Place<TopupStatus> {
341    fn string(&mut self, s: &str) -> miniserde::Result<()> {
342        use std::str::FromStr;
343        self.out = Some(TopupStatus::from_str(s).map_err(|_| miniserde::Error)?);
344        Ok(())
345    }
346}
347
348stripe_types::impl_from_val_with_from_str!(TopupStatus);
349#[cfg(feature = "deserialize")]
350impl<'de> serde::Deserialize<'de> for TopupStatus {
351    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
352        use std::str::FromStr;
353        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
354        Self::from_str(&s).map_err(|_| serde::de::Error::custom("Unknown value for TopupStatus"))
355    }
356}
357impl stripe_types::Object for Topup {
358    type Id = stripe_shared::TopupId;
359    fn id(&self) -> &Self::Id {
360        &self.id
361    }
362
363    fn into_id(self) -> Self::Id {
364        self.id
365    }
366}
367stripe_types::def_id!(TopupId);
stripe_shared/topup.rs

stripe_shared/
topup.rs
