Struct stripe::Transfer

pub struct Transfer {

    pub id: TransferId,
    pub amount: i64,
    pub amount_reversed: i64,
    pub balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub created: Timestamp,
    pub currency: Currency,
    pub description: Option<String>,
    pub destination: Option<Expandable<Account>>,
    pub destination_payment: Option<Expandable<Charge>>,
    pub livemode: bool,
    pub metadata: Metadata,
    pub reversals: List<TransferReversal>,
    pub reversed: bool,
    pub source_transaction: Option<Expandable<Charge>>,
    pub source_type: Option<TransferSourceType>,
    pub transfer_group: Option<String>,
}

The resource representing a Stripe “Transfer”.

For more details see https://stripe.com/docs/api/transfers/object

Fields

id: TransferId

Unique identifier for the object.

amount: i64

Amount in cents (or local equivalent) to be transferred.

amount_reversed: i64

Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

balance_transaction: Option<Expandable<BalanceTransaction>>

Balance transaction that describes the impact of this transfer on your account balance.

created: Timestamp

Time that this record of the transfer was first created.

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.

destination: Option<Expandable<Account>>

ID of the Stripe account the transfer was sent to.

destination_payment: Option<Expandable<Charge>>

If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

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.

reversals: List<TransferReversal>

A list of reversals that have been applied to the transfer.

reversed: bool

Whether the transfer has been fully reversed.

If the transfer is only partially reversed, this attribute will still be false.

source_transaction: Option<Expandable<Charge>>

ID of the charge or payment that was used to fund the transfer.

If null, the transfer was funded from the available balance.

source_type: Option<TransferSourceType>

The source balance this transfer came from.

One of card, fpx, or bank_account.

transfer_group: Option<String>

A string that identifies this transaction as part of a group.

See the Connect documentation for details.

Implementations

impl Transfer

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

Returns a list of existing transfers sent to connected accounts.

The transfers are returned in sorted order, with the most recently created transfers appearing first.

pub fn create(client: &Client, params: CreateTransfer<'_>) -> Response<Transfer>

To send funds from your Stripe account to a connected account, you create a new transfer object.

Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

pub fn retrieve( client: &Client, id: &TransferId, expand: &[&str] ) -> Response<Transfer>

Retrieves the details of an existing transfer.

Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

pub fn update( client: &Client, id: &TransferId, params: UpdateTransfer<'_> ) -> Response<Transfer>

Updates the specified transfer by setting the values of the parameters passed.

Any parameters not provided will be left unchanged. This request accepts only metadata as an argument.

Trait Implementations

impl Clone for Transfer

fn clone(&self) -> Transfer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Transfer

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

Formats the value using the given formatter.

impl Default for Transfer

fn default() -> Transfer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Transfer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for Transfer

type Id = TransferId

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 Transfer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.