Mayson Monorepo Documentation
    Preparing search index...

    Interface ReceivedDebit

    ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.

    interface ReceivedDebit {
        id: string;
        object: "treasury.received_debit";
        amount: number;
        created: number;
        currency: string;
        description: string;
        failure_code: Stripe.Treasury.ReceivedDebit.FailureCode;
        financial_account: string;
        hosted_regulatory_receipt_url: string;
        initiating_payment_method_details?: Stripe.Treasury.ReceivedDebit.InitiatingPaymentMethodDetails;
        linked_flows: Stripe.Treasury.ReceivedDebit.LinkedFlows;
        livemode: boolean;
        network: Stripe.Treasury.ReceivedDebit.Network;
        reversal_details: Stripe.Treasury.ReceivedDebit.ReversalDetails;
        status: Stripe.Treasury.ReceivedDebit.Status;
        transaction: string | Stripe.Treasury.Transaction;
    }
    Index

    Properties

    id object amount created currency description failure_code financial_account hosted_regulatory_receipt_url initiating_payment_method_details? linked_flows livemode network reversal_details status transaction

    Properties

    id: string

    Unique identifier for the object.

    object: "treasury.received_debit"

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

    amount: number

    Amount (in cents) transferred.

    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.

    failure_code: Stripe.Treasury.ReceivedDebit.FailureCode

    Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.

    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.

    initiating_payment_method_details?: Stripe.Treasury.ReceivedDebit.InitiatingPaymentMethodDetails
    linked_flows: Stripe.Treasury.ReceivedDebit.LinkedFlows
    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    network: Stripe.Treasury.ReceivedDebit.Network

    The network used for the ReceivedDebit.

    reversal_details: Stripe.Treasury.ReceivedDebit.ReversalDetails

    Details describing when a ReceivedDebit might be reversed.

    status: Stripe.Treasury.ReceivedDebit.Status

    Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.

    transaction: string | Stripe.Treasury.Transaction

    The Transaction associated with this object.

    Settings

    Member Visibility

    On This Page

    Properties