Class: Stripe::Dispute

Inherits:
APIResource show all
Extended by:
APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/dispute.rb

Overview

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

Defined Under Namespace

Classes: Evidence, EvidenceDetails, PaymentMethodDetails, SmartDisputes

Constant Summary collapse

OBJECT_NAME = 
"dispute"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amount ⇒ Object (readonly)

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).



426
427
428
 
# File 'lib/stripe/resources/dispute.rb', line 426

def amount
  @amount
end

#amount_to_counter ⇒ Object (readonly)

The amount you want to contest, in the dispute's currency. Setting this to less than the full dispute amount means accepting the loss on the remaining amount. If not specified, the entire disputed amount is contested.



428
429
430
 
# File 'lib/stripe/resources/dispute.rb', line 428

def amount_to_counter
  @amount_to_counter
end

#balance_transactions ⇒ Object (readonly)

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



430
431
432
 
# File 'lib/stripe/resources/dispute.rb', line 430

def balance_transactions
  @balance_transactions
end

#charge ⇒ Object (readonly)

ID of the charge that's disputed.



432
433
434
 
# File 'lib/stripe/resources/dispute.rb', line 432

def charge
  @charge
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



434
435
436
 
# File 'lib/stripe/resources/dispute.rb', line 434

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter ISO currency code, in lowercase. Must be a supported currency.



436
437
438
 
# File 'lib/stripe/resources/dispute.rb', line 436

def currency
  @currency
end

#enhanced_eligibility_types ⇒ Object (readonly)

List of eligibility types that are included in enhanced_evidence.



438
439
440
 
# File 'lib/stripe/resources/dispute.rb', line 438

def enhanced_eligibility_types
  @enhanced_eligibility_types
end

#evidence ⇒ Object (readonly)

Attribute for field evidence



440
441
442
 
# File 'lib/stripe/resources/dispute.rb', line 440

def evidence
  @evidence
end

#evidence_details ⇒ Object (readonly)

Attribute for field evidence_details



442
443
444
 
# File 'lib/stripe/resources/dispute.rb', line 442

def evidence_details
  @evidence_details
end

#id ⇒ Object (readonly)

Unique identifier for the object.



444
445
446
 
# File 'lib/stripe/resources/dispute.rb', line 444

def id
  @id
end

#intended_submission_method ⇒ Object (readonly)

Intended submission method for the dispute.



446
447
448
 
# File 'lib/stripe/resources/dispute.rb', line 446

def intended_submission_method
  @intended_submission_method
end

#is_charge_refundable ⇒ Object (readonly)

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.



448
449
450
 
# File 'lib/stripe/resources/dispute.rb', line 448

def is_charge_refundable
  @is_charge_refundable
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.



450
451
452
 
# File 'lib/stripe/resources/dispute.rb', line 450

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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.



452
453
454
 
# File 'lib/stripe/resources/dispute.rb', line 452

def metadata
  @metadata
end

#network_reason_code ⇒ Object (readonly)

Network-dependent reason code for the dispute.



454
455
456
 
# File 'lib/stripe/resources/dispute.rb', line 454

def network_reason_code
  @network_reason_code
end

#object ⇒ Object (readonly)

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



456
457
458
 
# File 'lib/stripe/resources/dispute.rb', line 456

def object
  @object
end

#payment_intent ⇒ Object (readonly)

ID of the PaymentIntent that's disputed.



458
459
460
 
# File 'lib/stripe/resources/dispute.rb', line 458

def payment_intent
  @payment_intent
end

#payment_method_details ⇒ Object (readonly)

Attribute for field payment_method_details



460
461
462
 
# File 'lib/stripe/resources/dispute.rb', line 460

def payment_method_details
  @payment_method_details
end

#reason ⇒ Object (readonly)

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.



462
463
464
 
# File 'lib/stripe/resources/dispute.rb', line 462

def reason
  @reason
end

#smart_disputes ⇒ Object (readonly)

Attribute for field smart_disputes



464
465
466
 
# File 'lib/stripe/resources/dispute.rb', line 464

def smart_disputes
  @smart_disputes
end

#status ⇒ Object (readonly)

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.



466
467
468
 
# File 'lib/stripe/resources/dispute.rb', line 466

def status
  @status
end

Class Method Details

.close(dispute, params = {}, opts = {}) ⇒ Object

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it), acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.



483
484
485
486
487
488
489
490
 
# File 'lib/stripe/resources/dispute.rb', line 483

def self.close(dispute, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(dispute) }),
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



518
519
520
 
# File 'lib/stripe/resources/dispute.rb', line 518

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



509
510
511
512
513
514
515
516
 
# File 'lib/stripe/resources/dispute.rb', line 509

def self.inner_class_types
  @inner_class_types = {
    evidence: Evidence,
    evidence_details: EvidenceDetails,
    payment_method_details: PaymentMethodDetails,
    smart_disputes: SmartDisputes,
  }
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of your disputes.



493
494
495
 
# File 'lib/stripe/resources/dispute.rb', line 493

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/disputes", params: params, opts: opts)
end

.object_name ⇒ Object 



15
16
17
 
# File 'lib/stripe/resources/dispute.rb', line 15

def self.object_name
  "dispute"
end

.update(dispute, params = {}, opts = {}) ⇒ Object

When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.



500
501
502
503
504
505
506
507
 
# File 'lib/stripe/resources/dispute.rb', line 500

def self.update(dispute, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#close(params = {}, opts = {}) ⇒ Object

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it), acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.



471
472
473
474
475
476
477
478
 
# File 'lib/stripe/resources/dispute.rb', line 471

def close(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end