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::{Deserialize, Result, make_place};
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                _ => <dyn Visitor>::ignore(),
124            })
125        }
126
127        fn deser_default() -> Self {
128            Self {
129                amount: Deserialize::default(),
130                balance_transaction: Deserialize::default(),
131                created: Deserialize::default(),
132                currency: Deserialize::default(),
133                description: Deserialize::default(),
134                expected_availability_date: Deserialize::default(),
135                failure_code: Deserialize::default(),
136                failure_message: Deserialize::default(),
137                id: Deserialize::default(),
138                livemode: Deserialize::default(),
139                metadata: Deserialize::default(),
140                source: Deserialize::default(),
141                statement_descriptor: Deserialize::default(),
142                status: Deserialize::default(),
143                transfer_group: Deserialize::default(),
144            }
145        }
146
147        fn take_out(&mut self) -> Option<Self::Out> {
148            let (
149                Some(amount),
150                Some(balance_transaction),
151                Some(created),
152                Some(currency),
153                Some(description),
154                Some(expected_availability_date),
155                Some(failure_code),
156                Some(failure_message),
157                Some(id),
158                Some(livemode),
159                Some(metadata),
160                Some(source),
161                Some(statement_descriptor),
162                Some(status),
163                Some(transfer_group),
164            ) = (
165                self.amount,
166                self.balance_transaction.take(),
167                self.created,
168                self.currency.take(),
169                self.description.take(),
170                self.expected_availability_date,
171                self.failure_code.take(),
172                self.failure_message.take(),
173                self.id.take(),
174                self.livemode,
175                self.metadata.take(),
176                self.source.take(),
177                self.statement_descriptor.take(),
178                self.status,
179                self.transfer_group.take(),
180            )
181            else {
182                return None;
183            };
184            Some(Self::Out {
185                amount,
186                balance_transaction,
187                created,
188                currency,
189                description,
190                expected_availability_date,
191                failure_code,
192                failure_message,
193                id,
194                livemode,
195                metadata,
196                source,
197                statement_descriptor,
198                status,
199                transfer_group,
200            })
201        }
202    }
203
204    impl Map for Builder<'_> {
205        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
206            self.builder.key(k)
207        }
208
209        fn finish(&mut self) -> Result<()> {
210            *self.out = self.builder.take_out();
211            Ok(())
212        }
213    }
214
215    impl ObjectDeser for Topup {
216        type Builder = TopupBuilder;
217    }
218
219    impl FromValueOpt for Topup {
220        fn from_value(v: Value) -> Option<Self> {
221            let Value::Object(obj) = v else {
222                return None;
223            };
224            let mut b = TopupBuilder::deser_default();
225            for (k, v) in obj {
226                match k.as_str() {
227                    "amount" => b.amount = FromValueOpt::from_value(v),
228                    "balance_transaction" => b.balance_transaction = FromValueOpt::from_value(v),
229                    "created" => b.created = FromValueOpt::from_value(v),
230                    "currency" => b.currency = FromValueOpt::from_value(v),
231                    "description" => b.description = FromValueOpt::from_value(v),
232                    "expected_availability_date" => {
233                        b.expected_availability_date = FromValueOpt::from_value(v)
234                    }
235                    "failure_code" => b.failure_code = FromValueOpt::from_value(v),
236                    "failure_message" => b.failure_message = FromValueOpt::from_value(v),
237                    "id" => b.id = FromValueOpt::from_value(v),
238                    "livemode" => b.livemode = FromValueOpt::from_value(v),
239                    "metadata" => b.metadata = FromValueOpt::from_value(v),
240                    "source" => b.source = FromValueOpt::from_value(v),
241                    "statement_descriptor" => b.statement_descriptor = FromValueOpt::from_value(v),
242                    "status" => b.status = FromValueOpt::from_value(v),
243                    "transfer_group" => b.transfer_group = FromValueOpt::from_value(v),
244                    _ => {}
245                }
246            }
247            b.take_out()
248        }
249    }
250};
251#[cfg(feature = "serialize")]
252impl serde::Serialize for Topup {
253    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
254        use serde::ser::SerializeStruct;
255        let mut s = s.serialize_struct("Topup", 16)?;
256        s.serialize_field("amount", &self.amount)?;
257        s.serialize_field("balance_transaction", &self.balance_transaction)?;
258        s.serialize_field("created", &self.created)?;
259        s.serialize_field("currency", &self.currency)?;
260        s.serialize_field("description", &self.description)?;
261        s.serialize_field("expected_availability_date", &self.expected_availability_date)?;
262        s.serialize_field("failure_code", &self.failure_code)?;
263        s.serialize_field("failure_message", &self.failure_message)?;
264        s.serialize_field("id", &self.id)?;
265        s.serialize_field("livemode", &self.livemode)?;
266        s.serialize_field("metadata", &self.metadata)?;
267        s.serialize_field("source", &self.source)?;
268        s.serialize_field("statement_descriptor", &self.statement_descriptor)?;
269        s.serialize_field("status", &self.status)?;
270        s.serialize_field("transfer_group", &self.transfer_group)?;
271
272        s.serialize_field("object", "topup")?;
273        s.end()
274    }
275}
276/// The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
277#[derive(Copy, Clone, Eq, PartialEq)]
278pub enum TopupStatus {
279    Canceled,
280    Failed,
281    Pending,
282    Reversed,
283    Succeeded,
284}
285impl TopupStatus {
286    pub fn as_str(self) -> &'static str {
287        use TopupStatus::*;
288        match self {
289            Canceled => "canceled",
290            Failed => "failed",
291            Pending => "pending",
292            Reversed => "reversed",
293            Succeeded => "succeeded",
294        }
295    }
296}
297
298impl std::str::FromStr for TopupStatus {
299    type Err = stripe_types::StripeParseError;
300    fn from_str(s: &str) -> Result<Self, Self::Err> {
301        use TopupStatus::*;
302        match s {
303            "canceled" => Ok(Canceled),
304            "failed" => Ok(Failed),
305            "pending" => Ok(Pending),
306            "reversed" => Ok(Reversed),
307            "succeeded" => Ok(Succeeded),
308            _ => Err(stripe_types::StripeParseError),
309        }
310    }
311}
312impl std::fmt::Display for TopupStatus {
313    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
314        f.write_str(self.as_str())
315    }
316}
317
318impl std::fmt::Debug for TopupStatus {
319    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
320        f.write_str(self.as_str())
321    }
322}
323#[cfg(feature = "serialize")]
324impl serde::Serialize for TopupStatus {
325    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
326    where
327        S: serde::Serializer,
328    {
329        serializer.serialize_str(self.as_str())
330    }
331}
332impl miniserde::Deserialize for TopupStatus {
333    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
334        crate::Place::new(out)
335    }
336}
337
338impl miniserde::de::Visitor for crate::Place<TopupStatus> {
339    fn string(&mut self, s: &str) -> miniserde::Result<()> {
340        use std::str::FromStr;
341        self.out = Some(TopupStatus::from_str(s).map_err(|_| miniserde::Error)?);
342        Ok(())
343    }
344}
345
346stripe_types::impl_from_val_with_from_str!(TopupStatus);
347#[cfg(feature = "deserialize")]
348impl<'de> serde::Deserialize<'de> for TopupStatus {
349    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
350        use std::str::FromStr;
351        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
352        Self::from_str(&s).map_err(|_| serde::de::Error::custom("Unknown value for TopupStatus"))
353    }
354}
355impl stripe_types::Object for Topup {
356    type Id = stripe_shared::TopupId;
357    fn id(&self) -> &Self::Id {
358        &self.id
359    }
360
361    fn into_id(self) -> Self::Id {
362        self.id
363    }
364}
365stripe_types::def_id!(TopupId);
stripe_shared/topup.rs

stripe_shared/
topup.rs
