Mayson Monorepo Documentation
    Preparing search index...

    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

    interface TransferReversal {
        id: string;
        object: "transfer_reversal";
        amount: number;
        balance_transaction: string | Stripe.BalanceTransaction;
        created: number;
        currency: string;
        destination_payment_refund: string | Stripe.Refund;
        metadata: Metadata;
        source_refund: string | Stripe.Refund;
        transfer: string | Transfer;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "transfer_reversal"

    String representing the object's type. Objects of the same type share the same value.

    amount: number

    Amount, in cents (or local equivalent).

    balance_transaction: string | Stripe.BalanceTransaction

    Balance transaction that describes the impact on your account balance.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    currency: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    destination_payment_refund: string | Stripe.Refund

    Linked payment refund for the transfer reversal.

    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_refund: string | Stripe.Refund

    ID of the refund responsible for the transfer reversal.

    transfer: string | Transfer

    ID of the transfer that was reversed.