Dispute (stripe-java 10.0.2 API)

java.lang.Object
- com.stripe.model.StripeObject
- - com.stripe.net.ApiResource
  - - com.stripe.model.Dispute

All Implemented Interfaces:: BalanceTransactionSource, HasId, MetadataStore<Dispute>

public class Dispute
extends ApiResource
implements BalanceTransactionSource, MetadataStore<Dispute>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Dispute.Evidence

static class Dispute.EvidenceDetails
- Nested classes/interfaces inherited from class com.stripe.net.ApiResource
  ApiResource.RequestMethod, ApiResource.RequestType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Dispute.Evidence`
`static class`	`Dispute.EvidenceDetails`

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 and Description

Dispute()

Constructors
Constructor and Description
`Dispute()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`Dispute`	`close()` 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.
`Dispute`	`close(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.
`Dispute`	`close(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.
`Dispute`	`close(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.
`Dispute`	`close(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.
`Dispute`	`close(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.
`boolean`	`equals(java.lang.Object o)`
`java.lang.Long`	`getAmount()` 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.String`	`getCharge()` Get id of expandable `charge` object.
`Charge`	`getChargeObject()` Get expanded `charge`.
`java.lang.Long`	`getCreated()` Time at which the object was created.
`java.lang.String`	`getCurrency()` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
`Dispute.Evidence`	`getEvidence()`
`Dispute.EvidenceDetails`	`getEvidenceDetails()`
`java.lang.String`	`getId()` Unique identifier for the object.
`java.lang.Boolean`	`getIsChargeRefundable()` If true, it is still possible to refund the disputed payment.
`java.lang.Boolean`	`getLivemode()` Has the value `true` if the object exists in live mode or the value `false` if 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.String`	`getNetworkReasonCode()` Network-dependent reason code for the dispute.
`java.lang.String`	`getObject()` String representing the object's type.
`java.lang.String`	`getReason()` Reason given by cardholder for dispute.
`java.lang.String`	`getStatus()` Current status of dispute.
`int`	`hashCode()`
`static DisputeCollection`	`list(DisputeListParams params)` Returns a list of your disputes.
`static DisputeCollection`	`list(DisputeListParams params, RequestOptions options)` Returns a list of your disputes.
`static DisputeCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params)` Returns a list of your disputes.
`static DisputeCollection`	`list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Returns a list of your disputes.
`static Dispute`	`retrieve(java.lang.String dispute)` Retrieves the dispute with the given ID.
`static Dispute`	`retrieve(java.lang.String dispute, DisputeRetrieveParams params, RequestOptions options)` Retrieves the dispute with the given ID.
`static Dispute`	`retrieve(java.lang.String dispute, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)` Retrieves the dispute with the given ID.
`static Dispute`	`retrieve(java.lang.String dispute, RequestOptions options)` Retrieves the dispute with the given ID.
`void`	`setAmount(java.lang.Long amount)` Disputed amount.
`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.
`void`	`setCharge(java.lang.String id)`
`void`	`setChargeObject(Charge expandableObject)`
`void`	`setCreated(java.lang.Long created)` Time at which the object was created.
`void`	`setCurrency(java.lang.String currency)` Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
`void`	`setEvidence(Dispute.Evidence evidence)`
`void`	`setEvidenceDetails(Dispute.EvidenceDetails evidenceDetails)`
`void`	`setId(java.lang.String id)` Unique identifier for the object.
`void`	`setIsChargeRefundable(java.lang.Boolean isChargeRefundable)` If true, it is still possible to refund the disputed payment.
`void`	`setLivemode(java.lang.Boolean livemode)` Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Set of key-value pairs that you can attach to an object.
`void`	`setNetworkReasonCode(java.lang.String networkReasonCode)` Network-dependent reason code for the dispute.
`void`	`setObject(java.lang.String object)` String representing the object's type.
`void`	`setReason(java.lang.String reason)` Reason given by cardholder for dispute.
`void`	`setStatus(java.lang.String status)` Current status of dispute.
`Dispute`	`update(DisputeUpdateParams params)` When you get a dispute, contacting your customer is always the best first step.
`Dispute`	`update(DisputeUpdateParams params, RequestOptions options)` When you get a dispute, contacting your customer is always the best first step.
`Dispute`	`update(java.util.Map<java.lang.String,java.lang.Object> params)` When you get a dispute, contacting your customer is always the best first step.
`Dispute`	`update(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, multipartRequest, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Dispute
```
public Dispute()
```
- Method Detail
  - getCharge
```
public java.lang.String getCharge()
```
    Get id of expandable `charge` object.
  - setCharge
```
public void setCharge(java.lang.String id)
```
  - getChargeObject
```
public Charge getChargeObject()
```
    Get expanded `charge`.
  - setChargeObject
```
public void setChargeObject(Charge 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:
    
    update in interface MetadataStore<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:
    
    update in interface MetadataStore<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_response to lost. 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_response to lost. 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_response to lost. 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_response to lost. 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_response to lost. 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_response to lost. 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](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
  - 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 value `true` if the object exists in live mode or the value `false` if 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.
  - getReason
```
public java.lang.String getReason()
```
    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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories).
  - getStatus
```
public java.lang.String getStatus()
```
    Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`.
  - 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](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
  - 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 value `true` if the object exists in live mode or the value `false` if 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.
  - setReason
```
public void setReason(java.lang.String 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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories).
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getId
```
public java.lang.String getId()
```
    Unique identifier for the object.
    
    Specified by:
    
    getId in interface HasId
  - 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:
    
    getMetadata in interface MetadataStore<Dispute>

Class Dispute

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

Field Summary

Fields inherited from class com.stripe.net.ApiResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.ApiResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Dispute

Method Detail

getCharge

setCharge

getChargeObject

setChargeObject

list

list

list

list

retrieve

retrieve

retrieve

retrieve

update

update

update

update

close

close

close

close

close

close

getAmount

getBalanceTransactions

getCreated

getCurrency

getEvidence

getEvidenceDetails

getIsChargeRefundable

getLivemode

getNetworkReasonCode

getObject

getReason

getStatus

setAmount

setBalanceTransactions

setCreated

setCurrency

setEvidence

setEvidenceDetails

setId

setIsChargeRefundable

setLivemode

setMetadata

setNetworkReasonCode

setObject

setReason

setStatus

equals

canEqual

hashCode

getId

getMetadata