Struct TransferReversal

pub struct TransferReversal {
    pub amount: i64,
    pub balance_transaction: Option<Expandable<BalanceTransaction>>,
    pub created: i64,
    pub currency: Currency,
    pub destination_payment_refund: Option<Expandable<Refund>>,
    pub id: TransferReversalId,
    pub metadata: Option<HashMap<String, String>>,
    pub source_refund: Option<Expandable<Refund>>,
    pub transfer: Expandable<Transfer>,
}

Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform’s balance and subtract from the destination account’s balance.

Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal.

Related guide: Reverse transfers.

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

Fields

amount: i64

Amount, in cents (or local equivalent).

balance_transaction: Option<Expandable<BalanceTransaction>>

Balance transaction that describes the impact on your account balance.

created: i64

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.

destination_payment_refund: Option<Expandable<Refund>>

Linked payment refund for the transfer reversal.

id: TransferReversalId

Unique identifier for the object.

metadata: Option<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_refund: Option<Expandable<Refund>>

ID of the refund responsible for the transfer reversal.

transfer: Expandable<Transfer>

ID of the transfer that was reversed.

Trait Implementations

impl Clone for TransferReversal

fn clone(&self) -> TransferReversal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransferReversal

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

Formats the value using the given formatter.

impl Deserialize for TransferReversal

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

The only correct implementation of this method is:

impl Object for TransferReversal

type Id = TransferReversalId

The canonical id type for this object.

fn id(&self) -> &<TransferReversal as Object>::Id

The id of the object.

fn into_id(self) -> <TransferReversal as Object>::Id

The owned id of the object.

impl ObjectDeser for TransferReversal

type Builder = TransferReversalBuilder