[−][src]Struct stripe::Topup
The resource representing a Stripe "Topup".
For more details see https://stripe.com/docs/api/topups/object.
Fields
id: TopupId
Unique identifier for the object.
amount: i64
Amount transferred.
balance_transaction: Option<Expandable<BalanceTransaction>>
ID of the balance transaction that describes the impact of this top-up on your account balance.
May not be specified depending on status of top-up.
created: Timestamp
Time at which the object was created.
Measured in seconds since the Unix epoch.
currency: Currency
Three-letter ISO currency code, in lowercase.
Must be a supported currency.
description: Option<String>
An arbitrary string attached to the object.
Often useful for displaying to users.
expected_availability_date: Option<Timestamp>
Date the funds are expected to arrive in your Stripe account for payouts.
This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
failure_code: Option<String>
Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
failure_message: Option<String>
Message to user further explaining reason for top-up failure if available.
livemode: bool
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
metadata: Metadata
Set of key-value pairs that you can attach to an object.
This can be useful for storing additional information about the object in a structured format.
source: Source
statement_descriptor: Option<String>
Extra information about a top-up.
This will appear on your source's bank statement. It must contain at least one letter.
status: TopupStatus
The status of the top-up is either canceled
, failed
, pending
, reversed
, or succeeded
.
transfer_group: Option<String>
A string that identifies this top-up as part of a group.
Implementations
impl Topup
[src]
pub fn list(client: &Client, params: ListTopups) -> Response<List<Topup>>
[src]
Returns a list of top-ups.
pub fn retrieve(
client: &Client,
id: &TopupId,
expand: &[&str]
) -> Response<Topup>
[src]
client: &Client,
id: &TopupId,
expand: &[&str]
) -> Response<Topup>
Retrieves the details of a top-up that has previously been created.
Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
pub fn update(
client: &Client,
id: &TopupId,
params: UpdateTopup
) -> Response<Topup>
[src]
client: &Client,
id: &TopupId,
params: UpdateTopup
) -> Response<Topup>
Updates the metadata of a top-up.
Other top-up details are not editable by design.
Trait Implementations
impl Clone for Topup
[src]
impl Debug for Topup
[src]
impl<'de> Deserialize<'de> for Topup
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for Topup
[src]
type Id = TopupId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for Topup
[src]
Auto Trait Implementations
impl RefUnwindSafe for Topup
impl Send for Topup
impl Sync for Topup
impl Unpin for Topup
impl UnwindSafe for Topup
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,