Mayson Monorepo Documentation
    Preparing search index...

    A Transfer object is created when you move funds between Stripe accounts as part of Connect.

    Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split.

    Related guide: Creating separate charges and transfers

    interface Transfer {
        id: string;
        object: "transfer";
        amount: number;
        amount_reversed: number;
        balance_transaction: string | Stripe.BalanceTransaction;
        created: number;
        currency: string;
        description: string;
        destination: string | Stripe.Account;
        destination_payment?: string | Stripe.Charge;
        livemode: boolean;
        metadata: Metadata;
        reversals: ApiList<TransferReversal>;
        reversed: boolean;
        source_transaction: string | Stripe.Charge;
        source_type?: string;
        transfer_group: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "transfer"

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

    amount: number

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

    amount_reversed: number

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

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

    created: number

    Time that this record of the transfer was first created.

    currency: string

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

    description: string

    An arbitrary string attached to the object. Often useful for displaying to users.

    destination: string | Stripe.Account

    ID of the Stripe account the transfer was sent to.

    destination_payment?: string | Stripe.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: boolean

    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.

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

    reversed: boolean

    Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

    source_transaction: string | Stripe.Charge

    ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.

    source_type?: string

    The source balance this transfer came from. One of card, fpx, or bank_account.

    transfer_group: string

    A string that identifies this transaction as part of a group. See the Connect documentation for details.