Struct stripe::generated::connect::topup::Topup

pub struct Topup {

    pub id: TopupId,
    pub amount: i64,
    pub balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub created: Timestamp,
    pub currency: Currency,
    pub description: Option<String>,
    pub expected_availability_date: Option<Timestamp>,
    pub failure_code: Option<String>,
    pub failure_message: Option<String>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub source: Option<Source>,
    pub statement_descriptor: Option<String>,
    pub status: TopupStatus,
    pub transfer_group: Option<String>,
}

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: Option<Source>

The source field is deprecated.

It might not always be present in the API response.

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

pub fn list(client: &Client, params: &ListTopups<'_>) -> Response<List<Topup>>

Returns a list of top-ups.

pub fn retrieve( 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>

Updates the metadata of a top-up.

Other top-up details are not editable by design.

Trait Implementations

impl Clone for Topup

fn clone(&self) -> Topup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Topup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Topup

fn default() -> Topup

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Topup

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for Topup

type Id = TopupId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for Topup

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.