[−][src]Struct stripe::Transfer
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 %s to be transferred.
amount_reversed: i64
Amount in %s 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
A set of key-value pairs that you can attach to a transfer object.
It can be useful for storing additional information about the transfer 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
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
[src]
pub fn list(client: &Client, params: ListTransfers) -> Response<List<Transfer>>
[src]
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>
[src]
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>
[src]
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>
[src]
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
[src]
impl Debug for Transfer
[src]
impl<'de> Deserialize<'de> for Transfer
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Object for Transfer
[src]
type Id = TransferId
The canonical id type for this object.
fn id(&self) -> Self::Id
[src]
fn object(&self) -> &'static str
[src]
impl Serialize for Transfer
[src]
Auto Trait Implementations
impl RefUnwindSafe for Transfer
impl Send for Transfer
impl Sync for Transfer
impl Unpin for Transfer
impl UnwindSafe for Transfer
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>,