Struct Topup

pub struct Topup {

    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 id: TopupId,
    pub livemode: bool,
    pub metadata: HashMap<String, String>,
    pub source: Option<Source>,
    pub statement_descriptor: Option<String>,
    pub status: TopupStatus,
    pub transfer_group: Option<String>,
}

To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.

Related guide: Topping up your platform account

For more details see <https://stripe.com/docs/api/topups/object>.

Fields

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.

id: TopupId

Unique identifier for the object.

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: HashMap<String, String>

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.

Trait Implementations

impl Clone for Topup

fn clone(&self) -> Topup

Returns a duplicate 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 Deserialize for Topup

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for Topup

fn from_value(v: Value) -> Option<Self>

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 into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for Topup

type Builder = TopupBuilder