class

Stripe::Dispute

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [dispute]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [lost, needs_response, under_review, warning_closed, warning_needs_response, warning_under_review, won]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_NETWORK_REASON_CODE = 5000
MAX_LENGTH_FOR_REASON = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("dispute")
VALID_VALUES_FOR_STATUS = String.static_array("lost", "needs_response", "under_review", "warning_closed", "warning_needs_response", "warning_under_review", "won")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, balance_transactions : Array(Stripe::BalanceTransaction) | Nil = nil, charge : Stripe::DisputeCharge | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, evidence : Stripe::DisputeEvidence | Nil = nil, evidence_details : Stripe::DisputeEvidenceDetails | Nil = nil, id : String | Nil = nil, is_charge_refundable : Bool | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, payment_intent : Stripe::DisputePaymentIntent | Nil = nil, reason : String | Nil = nil, status : String | Nil = nil, network_reason_code : String | Nil = nil, payment_method_details : Stripe::DisputePaymentMethodDetails | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

amount

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

Source
amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

Source
balance_transactions

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

Source
balance_transactions=(new_value : Array(Stripe::BalanceTransaction) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] balance_transactions Object to be assigned

Source
charge
Source
charge=(new_value : Stripe::DisputeCharge | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] charge Object to be assigned

Source
created

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

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
currency

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

Source
currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source
evidence
Source
evidence=(new_value : Stripe::DisputeEvidence | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] evidence Object to be assigned

Source
evidence_details
Source
evidence_details=(new_value : Stripe::DisputeEvidenceDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] evidence_details Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
is_charge_refundable

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.

Source
is_charge_refundable=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] is_charge_refundable Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
network_reason_code

Network-dependent reason code for the dispute.

Source
network_reason_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network_reason_code Object to be assigned

Source
network_reason_code_present=(network_reason_code_present : Bool)
Source
network_reason_code_present?
Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
payment_intent
Source
payment_intent=(new_value : Stripe::DisputePaymentIntent | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_intent Object to be assigned

Source
payment_method_details
Source
payment_method_details=(new_value : Stripe::DisputePaymentMethodDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_method_details Object to be assigned

Source
reason

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, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Learn more about dispute reasons.

Source
reason=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] reason Object to be assigned

Source
status

Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, won, or lost.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source