Mayson Monorepo Documentation
    Preparing search index...

    A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.

    Related guide: Disputes and fraud

    interface Dispute {
        id: string;
        object: "dispute";
        amount: number;
        balance_transactions: Stripe.BalanceTransaction[];
        charge: string | Stripe.Charge;
        created: number;
        currency: string;
        enhanced_eligibility_types: EnhancedEligibilityType[];
        evidence: Stripe.Dispute.Evidence;
        evidence_details: Stripe.Dispute.EvidenceDetails;
        is_charge_refundable: boolean;
        livemode: boolean;
        metadata: Metadata;
        network_reason_code?: string;
        payment_intent: string | Stripe.PaymentIntent;
        payment_method_details?: Stripe.Dispute.PaymentMethodDetails;
        reason: string;
        status: Stripe.Dispute.Status;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "dispute"

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

    amount: number

    Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).

    balance_transactions: Stripe.BalanceTransaction[]

    List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.

    charge: string | Stripe.Charge

    ID of the charge that's disputed.

    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.

    enhanced_eligibility_types: EnhancedEligibilityType[]

    List of eligibility types that are included in enhanced_evidence.

    evidence_details: Stripe.Dispute.EvidenceDetails
    is_charge_refundable: boolean

    If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.

    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_reason_code?: string

    Network-dependent reason code for the dispute.

    payment_intent: string | Stripe.PaymentIntent

    ID of the PaymentIntent that's disputed.

    payment_method_details?: Stripe.Dispute.PaymentMethodDetails
    reason: string

    Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, noncompliant, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Learn more about dispute reasons.

    The current status of a dispute. Possible values include:warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, won, lost, or prevented.