Mayson Monorepo Documentation
    Preparing search index...

    Interface CreditReversal

    You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.

    interface CreditReversal {
        id: string;
        object: "treasury.credit_reversal";
        amount: number;
        created: number;
        currency: string;
        financial_account: string;
        hosted_regulatory_receipt_url: string;
        livemode: boolean;
        metadata: Metadata;
        network: Stripe.Treasury.CreditReversal.Network;
        received_credit: string;
        status: Stripe.Treasury.CreditReversal.Status;
        status_transitions: Stripe.Treasury.CreditReversal.StatusTransitions;
        transaction: string | Stripe.Treasury.Transaction;
    }
    Index

    Properties

    id object amount created currency financial_account hosted_regulatory_receipt_url livemode metadata network received_credit status status_transitions transaction

    Properties

    id: string

    Unique identifier for the object.

    object: "treasury.credit_reversal"

    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.

    financial_account: string

    The FinancialAccount to reverse funds 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.

    network: Stripe.Treasury.CreditReversal.Network

    The rails used to reverse the funds.

    received_credit: string

    The ReceivedCredit being reversed.

    status: Stripe.Treasury.CreditReversal.Status

    Status of the CreditReversal

    status_transitions: Stripe.Treasury.CreditReversal.StatusTransitions
    transaction: string | Stripe.Treasury.Transaction

    The Transaction associated with this object.

    Settings

    Member Visibility

    On This Page

    Properties