Mayson Monorepo Documentation
    Preparing search index...

    Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged.

    Related guide: Refunds

    interface Refund {
        id: string;
        object: "refund";
        amount: number;
        balance_transaction: string | Stripe.BalanceTransaction;
        charge: string | Stripe.Charge;
        created: number;
        currency: string;
        description?: string;
        destination_details?: Stripe.Refund.DestinationDetails;
        failure_balance_transaction?: string | Stripe.BalanceTransaction;
        failure_reason?: string;
        instructions_email?: string;
        metadata: Metadata;
        next_action?: Stripe.Refund.NextAction;
        payment_intent: string | Stripe.PaymentIntent;
        pending_reason?: PendingReason;
        presentment_details?: Stripe.Refund.PresentmentDetails;
        reason: Stripe.Refund.Reason;
        receipt_number: string;
        source_transfer_reversal: string | TransferReversal;
        status: string;
        transfer_reversal: string | TransferReversal;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "refund"

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

    amount: number

    Amount, in cents (or local equivalent).

    balance_transaction: string | Stripe.BalanceTransaction

    Balance transaction that describes the impact on your account balance.

    charge: string | Stripe.Charge

    ID of the charge that's refunded.

    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. You can use this for displaying to users (available on non-card refunds only).

    destination_details?: Stripe.Refund.DestinationDetails
    failure_balance_transaction?: string | Stripe.BalanceTransaction

    After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.

    failure_reason?: string

    Provides the reason for the refund failure. Possible values are: lost_or_stolen_card, expired_or_canceled_card, charge_for_pending_refund_disputed, insufficient_funds, declined, merchant_request, or unknown.

    instructions_email?: string

    For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.

    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.

    next_action?: Stripe.Refund.NextAction
    payment_intent: string | Stripe.PaymentIntent

    ID of the PaymentIntent that's refunded.

    pending_reason?: PendingReason

    Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.

    presentment_details?: Stripe.Refund.PresentmentDetails

    Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

    receipt_number: string

    This is the transaction number that appears on email receipts sent for this refund.

    source_transfer_reversal: string | TransferReversal

    The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.

    status: string

    Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled. Learn more about failed refunds.

    transfer_reversal: string | TransferReversal

    This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.