Mayson Monorepo Documentation
    Preparing search index...

    Interface TransactionCreateReversalParams

    interface TransactionCreateReversalParams {
        mode: Stripe.Tax.TransactionCreateReversalParams.Mode;
        original_transaction: string;
        reference: string;
        expand?: string[];
        flat_amount?: number;
        line_items?: Stripe.Tax.TransactionCreateReversalParams.LineItem[];
        metadata?: MetadataParam;
        shipping_cost?: Stripe.Tax.TransactionCreateReversalParams.ShippingCost;
    }
    Index

    Properties

    If partial, the provided line item or shipping cost amounts are reversed. If full, the original transaction is fully reversed.

    original_transaction: string

    The ID of the Transaction to partially or fully reverse.

    reference: string

    A custom identifier for this reversal, such as myOrder_123-refund_1, which must be unique across all transactions. The reference helps identify this reversal transaction in exported tax reports.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    flat_amount?: number

    A flat amount to reverse across the entire transaction, in the smallest currency unit in negative. This value represents the total amount to refund from the transaction, including taxes.

    The line item amounts to reverse.

    metadata?: MetadataParam

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    The shipping cost to reverse.