Mayson Monorepo Documentation
    Preparing search index...

    Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.

    Related guide: Moving money with Treasury using InboundTransfer objects

    interface InboundTransfer {
        id: string;
        object: "treasury.inbound_transfer";
        amount: number;
        cancelable: boolean;
        created: number;
        currency: string;
        description: string;
        failure_details: Stripe.Treasury.InboundTransfer.FailureDetails;
        financial_account: string;
        hosted_regulatory_receipt_url: string;
        linked_flows: Stripe.Treasury.InboundTransfer.LinkedFlows;
        livemode: boolean;
        metadata: Metadata;
        origin_payment_method: string;
        origin_payment_method_details: Stripe.Treasury.InboundTransfer.OriginPaymentMethodDetails;
        returned: boolean;
        statement_descriptor: string;
        status: Stripe.Treasury.InboundTransfer.Status;
        status_transitions: Stripe.Treasury.InboundTransfer.StatusTransitions;
        transaction: string | Stripe.Treasury.Transaction;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "treasury.inbound_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 InboundTransfer is able to be canceled.

    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.

    Details about this InboundTransfer's failure. Only set when status is failed.

    financial_account: string

    The FinancialAccount that received the funds.

    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.

    origin_payment_method: string

    The origin payment method to be debited for an InboundTransfer.

    Details about the PaymentMethod for an InboundTransfer.

    returned: boolean

    Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.

    statement_descriptor: string

    Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.

    Status of the InboundTransfer: processing, succeeded, failed, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been "confirmed" and a transaction is created and posted. The status changes to failed if the transfer fails.

    transaction: string | Stripe.Treasury.Transaction

    The Transaction associated with this object.