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](stripe.com/docs/disputes)

Defined Under Namespace

Classes: CloseParams, Evidence, EvidenceDetails, ListParams, PaymentMethodDetails, SmartDisputes, UpdateParams

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?, #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).



755
756
757
 
# File 'lib/stripe/resources/dispute.rb', line 755

def amount
  @amount
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.



757
758
759
 
# File 'lib/stripe/resources/dispute.rb', line 757

def balance_transactions
  @balance_transactions
end

#charge ⇒ Object (readonly)

ID of the charge that’s disputed.



759
760
761
 
# File 'lib/stripe/resources/dispute.rb', line 759

def charge
  @charge
end

#created ⇒ Object (readonly)

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



761
762
763
 
# File 'lib/stripe/resources/dispute.rb', line 761

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



763
764
765
 
# File 'lib/stripe/resources/dispute.rb', line 763

def currency
  @currency
end

#enhanced_eligibility_types ⇒ Object (readonly)

List of eligibility types that are included in ‘enhanced_evidence`.



765
766
767
 
# File 'lib/stripe/resources/dispute.rb', line 765

def enhanced_eligibility_types
  @enhanced_eligibility_types
end

#evidence ⇒ Object (readonly)

Attribute for field evidence



767
768
769
 
# File 'lib/stripe/resources/dispute.rb', line 767

def evidence
  @evidence
end

#evidence_details ⇒ Object (readonly)

Attribute for field evidence_details



769
770
771
 
# File 'lib/stripe/resources/dispute.rb', line 769

def evidence_details
  @evidence_details
end

#id ⇒ Object (readonly)

Unique identifier for the object.



771
772
773
 
# File 'lib/stripe/resources/dispute.rb', line 771

def id
  @id
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.



773
774
775
 
# File 'lib/stripe/resources/dispute.rb', line 773

def is_charge_refundable
  @is_charge_refundable
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



775
776
777
 
# File 'lib/stripe/resources/dispute.rb', line 775

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



777
778
779
 
# File 'lib/stripe/resources/dispute.rb', line 777

def metadata
  @metadata
end

#network_reason_code ⇒ Object (readonly)

Network-dependent reason code for the dispute.



779
780
781
 
# File 'lib/stripe/resources/dispute.rb', line 779

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.



781
782
783
 
# File 'lib/stripe/resources/dispute.rb', line 781

def object
  @object
end

#payment_intent ⇒ Object (readonly)

ID of the PaymentIntent that’s disputed.



783
784
785
 
# File 'lib/stripe/resources/dispute.rb', line 783

def payment_intent
  @payment_intent
end

#payment_method_details ⇒ Object (readonly)

Attribute for field payment_method_details



785
786
787
 
# File 'lib/stripe/resources/dispute.rb', line 785

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](stripe.com/docs/disputes/categories).



787
788
789
 
# File 'lib/stripe/resources/dispute.rb', line 787

def reason
  @reason
end

#smart_disputes ⇒ Object (readonly)

Attribute for field smart_disputes



789
790
791
 
# File 'lib/stripe/resources/dispute.rb', line 789

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



791
792
793
 
# File 'lib/stripe/resources/dispute.rb', line 791

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, acknowledging it as lost.

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



808
809
810
811
812
813
814
815
 
# File 'lib/stripe/resources/dispute.rb', line 808

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 



843
844
845
 
# File 'lib/stripe/resources/dispute.rb', line 843

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



834
835
836
837
838
839
840
841
 
# File 'lib/stripe/resources/dispute.rb', line 834

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.



818
819
820
 
# File 'lib/stripe/resources/dispute.rb', line 818

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](dashboard.stripe.com/disputes), 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](docs.stripe.com/docs/disputes/categories).



825
826
827
828
829
830
831
832
 
# File 'lib/stripe/resources/dispute.rb', line 825

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, acknowledging it as lost.

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



796
797
798
799
800
801
802
803
 
# File 'lib/stripe/resources/dispute.rb', line 796

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