Mayson Monorepo Documentation
    Preparing search index...

    Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.

    Simulate OutboundTransfer state changes with the /v1/test_helpers/treasury/outbound_transfers endpoints. These methods can only be called on test mode objects.

    Related guide: Moving money with Treasury using OutboundTransfer objects

    interface OutboundTransfer {
        id: string;
        object: "treasury.outbound_transfer";
        amount: number;
        cancelable: boolean;
        created: number;
        currency: string;
        description: string;
        destination_payment_method: string;
        destination_payment_method_details: Stripe.Treasury.OutboundTransfer.DestinationPaymentMethodDetails;
        expected_arrival_date: number;
        financial_account: string;
        hosted_regulatory_receipt_url: string;
        livemode: boolean;
        metadata: Metadata;
        returned_details: Stripe.Treasury.OutboundTransfer.ReturnedDetails;
        statement_descriptor: string;
        status: Stripe.Treasury.OutboundTransfer.Status;
        status_transitions: Stripe.Treasury.OutboundTransfer.StatusTransitions;
        tracking_details: Stripe.Treasury.OutboundTransfer.TrackingDetails;
        transaction: string | Stripe.Treasury.Transaction;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "treasury.outbound_transfer"

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

    amount: number

    Amount (in cents) transferred.

    cancelable: boolean

    Returns true if the object can be canceled, and false otherwise.

    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.

    description: string

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

    destination_payment_method: string

    The PaymentMethod used as the payment instrument for an OutboundTransfer.

    expected_arrival_date: number

    The date when funds are expected to arrive in the destination account.

    financial_account: string

    The FinancialAccount that funds were pulled from.

    hosted_regulatory_receipt_url: string

    A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

    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.

    Details about a returned OutboundTransfer. Only set when the status is returned.

    statement_descriptor: string

    Information about the OutboundTransfer to be sent to the recipient account.

    Current status of the OutboundTransfer: processing, failed, canceled, posted, returned. An OutboundTransfer is processing if it has been created and is pending. The status changes to posted once the OutboundTransfer has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundTransfer fails to arrive at its destination, its status will change to returned.

    Details about network-specific tracking information if available.

    transaction: string | Stripe.Treasury.Transaction

    The Transaction associated with this object.