Class Dispute
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.Dispute
-
- All Implemented Interfaces:
BalanceTransactionSource,HasId,MetadataStore<Dispute>,StripeObjectInterface
public class Dispute extends ApiResource implements MetadataStore<Dispute>, BalanceTransactionSource
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDispute.Evidencestatic classDispute.EvidenceDetails-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description Dispute()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(java.lang.Object other)Disputeclose()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.Disputeclose(RequestOptions options)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.Disputeclose(DisputeCloseParams params)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.Disputeclose(DisputeCloseParams params, RequestOptions options)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.Disputeclose(java.util.Map<java.lang.String,java.lang.Object> params)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.Disputeclose(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)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.booleanequals(java.lang.Object o)java.lang.LonggetAmount()Disputed amount.java.util.List<BalanceTransaction>getBalanceTransactions()List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.java.lang.StringgetCharge()Get ID of expandablechargeobject.ChargegetChargeObject()Get expandedcharge.java.lang.LonggetCreated()Time at which the object was created.java.lang.StringgetCurrency()Three-letter ISO currency code, in lowercase.Dispute.EvidencegetEvidence()Dispute.EvidenceDetailsgetEvidenceDetails()java.lang.StringgetId()Unique identifier for the object.java.lang.BooleangetIsChargeRefundable()If true, it is still possible to refund the disputed payment.java.lang.BooleangetLivemode()Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.java.util.Map<java.lang.String,java.lang.String>getMetadata()Set of key-value pairs that you can attach to an object.java.lang.StringgetNetworkReasonCode()Network-dependent reason code for the dispute.java.lang.StringgetObject()String representing the object's type.java.lang.StringgetPaymentIntent()Get ID of expandablepaymentIntentobject.PaymentIntentgetPaymentIntentObject()Get expandedpaymentIntent.java.lang.StringgetReason()Reason given by cardholder for dispute.java.lang.StringgetStatus()Current status of dispute.inthashCode()static DisputeCollectionlist(DisputeListParams params)Returns a list of your disputes.static DisputeCollectionlist(DisputeListParams params, RequestOptions options)Returns a list of your disputes.static DisputeCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params)Returns a list of your disputes.static DisputeCollectionlist(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Returns a list of your disputes.static Disputeretrieve(java.lang.String dispute)Retrieves the dispute with the given ID.static Disputeretrieve(java.lang.String dispute, RequestOptions options)Retrieves the dispute with the given ID.static Disputeretrieve(java.lang.String dispute, DisputeRetrieveParams params, RequestOptions options)Retrieves the dispute with the given ID.static Disputeretrieve(java.lang.String dispute, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)Retrieves the dispute with the given ID.voidsetAmount(java.lang.Long amount)Disputed amount.voidsetBalanceTransactions(java.util.List<BalanceTransaction> balanceTransactions)List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.voidsetCharge(java.lang.String id)voidsetChargeObject(Charge expandableObject)voidsetCreated(java.lang.Long created)Time at which the object was created.voidsetCurrency(java.lang.String currency)Three-letter ISO currency code, in lowercase.voidsetEvidence(Dispute.Evidence evidence)voidsetEvidenceDetails(Dispute.EvidenceDetails evidenceDetails)voidsetId(java.lang.String id)Unique identifier for the object.voidsetIsChargeRefundable(java.lang.Boolean isChargeRefundable)If true, it is still possible to refund the disputed payment.voidsetLivemode(java.lang.Boolean livemode)Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.voidsetMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)Set of key-value pairs that you can attach to an object.voidsetNetworkReasonCode(java.lang.String networkReasonCode)Network-dependent reason code for the dispute.voidsetObject(java.lang.String object)String representing the object's type.voidsetPaymentIntent(java.lang.String id)voidsetPaymentIntentObject(PaymentIntent expandableObject)voidsetReason(java.lang.String reason)Reason given by cardholder for dispute.voidsetStatus(java.lang.String status)Current status of dispute.Disputeupdate(DisputeUpdateParams params)When you get a dispute, contacting your customer is always the best first step.Disputeupdate(DisputeUpdateParams params, RequestOptions options)When you get a dispute, contacting your customer is always the best first step.Disputeupdate(java.util.Map<java.lang.String,java.lang.Object> params)When you get a dispute, contacting your customer is always the best first step.Disputeupdate(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)When you get a dispute, contacting your customer is always the best first step.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.stripe.model.StripeObjectInterface
getLastResponse, setLastResponse
-
-
-
-
Method Detail
-
getCharge
public java.lang.String getCharge()
Get ID of expandablechargeobject.
-
setCharge
public void setCharge(java.lang.String id)
-
getChargeObject
public Charge getChargeObject()
Get expandedcharge.
-
setChargeObject
public void setChargeObject(Charge expandableObject)
-
getPaymentIntent
public java.lang.String getPaymentIntent()
Get ID of expandablepaymentIntentobject.
-
setPaymentIntent
public void setPaymentIntent(java.lang.String id)
-
getPaymentIntentObject
public PaymentIntent getPaymentIntentObject()
Get expandedpaymentIntent.
-
setPaymentIntentObject
public void setPaymentIntentObject(PaymentIntent expandableObject)
-
list
public static DisputeCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of your disputes.- Throws:
StripeException
-
list
public static DisputeCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of your disputes.- Throws:
StripeException
-
list
public static DisputeCollection list(DisputeListParams params) throws StripeException
Returns a list of your disputes.- Throws:
StripeException
-
list
public static DisputeCollection list(DisputeListParams params, RequestOptions options) throws StripeException
Returns a list of your disputes.- Throws:
StripeException
-
retrieve
public static Dispute retrieve(java.lang.String dispute) throws StripeException
Retrieves the dispute with the given ID.- Throws:
StripeException
-
retrieve
public static Dispute retrieve(java.lang.String dispute, RequestOptions options) throws StripeException
Retrieves the dispute with the given ID.- Throws:
StripeException
-
retrieve
public static Dispute retrieve(java.lang.String dispute, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the dispute with the given ID.- Throws:
StripeException
-
retrieve
public static Dispute retrieve(java.lang.String dispute, DisputeRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the dispute with the given ID.- Throws:
StripeException
-
update
public Dispute update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
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.
- Specified by:
updatein interfaceMetadataStore<Dispute>- Throws:
StripeException
-
update
public Dispute update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
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.
- Specified by:
updatein interfaceMetadataStore<Dispute>- Throws:
StripeException
-
update
public Dispute update(DisputeUpdateParams params) throws StripeException
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.
- Throws:
StripeException
-
update
public Dispute update(DisputeUpdateParams params, RequestOptions options) throws StripeException
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.
- Throws:
StripeException
-
close
public Dispute close() throws StripeException
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_responsetolost. Closing a dispute is irreversible.- Throws:
StripeException
-
close
public Dispute close(RequestOptions options) throws StripeException
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_responsetolost. Closing a dispute is irreversible.- Throws:
StripeException
-
close
public Dispute close(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
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_responsetolost. Closing a dispute is irreversible.- Throws:
StripeException
-
close
public Dispute close(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
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_responsetolost. Closing a dispute is irreversible.- Throws:
StripeException
-
close
public Dispute close(DisputeCloseParams params) throws StripeException
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_responsetolost. Closing a dispute is irreversible.- Throws:
StripeException
-
close
public Dispute close(DisputeCloseParams params, RequestOptions options) throws StripeException
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_responsetolost. Closing a dispute is irreversible.- Throws:
StripeException
-
getAmount
public java.lang.Long getAmount()
Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
-
getBalanceTransactions
public java.util.List<BalanceTransaction> getBalanceTransactions()
List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
getEvidence
public Dispute.Evidence getEvidence()
-
getEvidenceDetails
public Dispute.EvidenceDetails getEvidenceDetails()
-
getIsChargeRefundable
public java.lang.Boolean getIsChargeRefundable()
If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.
-
getNetworkReasonCode
public java.lang.String getNetworkReasonCode()
Network-dependent reason code for the dispute.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
dispute.
-
getReason
public java.lang.String getReason()
Reason given by cardholder for dispute. Possible values arebank_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, orunrecognized. Read more about dispute reasons.
-
getStatus
public java.lang.String getStatus()
Current status of dispute. Possible values arewarning_needs_response,warning_under_review,warning_closed,needs_response,under_review,charge_refunded,won, orlost.One of
charge_refunded,lost,needs_response,under_review,warning_closed,warning_needs_response,warning_under_review, orwon.
-
setAmount
public void setAmount(java.lang.Long amount)
Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).
-
setBalanceTransactions
public void setBalanceTransactions(java.util.List<BalanceTransaction> balanceTransactions)
List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setCurrency
public void setCurrency(java.lang.String currency)
Three-letter ISO currency code, in lowercase. Must be a supported currency.
-
setEvidence
public void setEvidence(Dispute.Evidence evidence)
-
setEvidenceDetails
public void setEvidenceDetails(Dispute.EvidenceDetails evidenceDetails)
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setIsChargeRefundable
public void setIsChargeRefundable(java.lang.Boolean isChargeRefundable)
If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> 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.
-
setNetworkReasonCode
public void setNetworkReasonCode(java.lang.String networkReasonCode)
Network-dependent reason code for the dispute.
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
dispute.
-
setReason
public void setReason(java.lang.String reason)
Reason given by cardholder for dispute. Possible values arebank_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, orunrecognized. Read more about dispute reasons.
-
setStatus
public void setStatus(java.lang.String status)
Current status of dispute. Possible values arewarning_needs_response,warning_under_review,warning_closed,needs_response,under_review,charge_refunded,won, orlost.One of
charge_refunded,lost,needs_response,under_review,warning_closed,warning_needs_response,warning_under_review, orwon.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
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.- Specified by:
getMetadatain interfaceMetadataStore<Dispute>
-
-