Package com.stripe.model.issuing

Class Dispute

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.issuing.Dispute

All Implemented Interfaces:

BalanceTransactionSource, HasId, MetadataStore<Dispute>, StripeActiveObject, StripeObjectInterface

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

As a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.

Related guide: Issuing disputes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dispute.Evidence
static class	Dispute.Treasury	Get expanded additionalDocumentation.

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

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Dispute()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Dispute	create(DisputeCreateParams params)	Creates an Issuing Dispute object.
static Dispute	create(DisputeCreateParams params, RequestOptions options)	Creates an Issuing Dispute object.
static Dispute	create(Map<String,Object> params)	Creates an Issuing Dispute object.
static Dispute	create(Map<String,Object> params, RequestOptions options)	Creates an Issuing Dispute object.
boolean	equals(Object o)
Long	getAmount()	Disputed amount in the card's currency and in the smallest currency unit.
List<BalanceTransaction>	getBalanceTransactions()	List of balance transactions associated with the dispute.
Long	getCreated()	Time at which the object was created.
String	getCurrency()	The currency the transaction was made in.
Dispute.Evidence	getEvidence()
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
String	getStatus()	Current status of the dispute.
String	getTransaction()	Get ID of expandable transaction object.
Transaction	getTransactionObject()	Get expanded transaction.
Dispute.Treasury	getTreasury()	Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
int	hashCode()
static DisputeCollection	list(DisputeListParams params)	Returns a list of Issuing Dispute objects.
static DisputeCollection	list(DisputeListParams params, RequestOptions options)	Returns a list of Issuing Dispute objects.
static DisputeCollection	list(Map<String,Object> params)	Returns a list of Issuing Dispute objects.
static DisputeCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of Issuing Dispute objects.
static Dispute	retrieve(String dispute)	Retrieves an Issuing Dispute object.
static Dispute	retrieve(String dispute, RequestOptions options)	Retrieves an Issuing Dispute object.
static Dispute	retrieve(String dispute, DisputeRetrieveParams params, RequestOptions options)	Retrieves an Issuing Dispute object.
static Dispute	retrieve(String dispute, Map<String,Object> params, RequestOptions options)	Retrieves an Issuing Dispute object.
void	setAmount(Long amount)	Disputed amount in the card's currency and in the smallest currency unit.
void	setBalanceTransactions(List<BalanceTransaction> balanceTransactions)	List of balance transactions associated with the dispute.
void	setCreated(Long created)	Time at which the object was created.
void	setCurrency(String currency)	The currency the transaction was made in.
void	setEvidence(Dispute.Evidence evidence)
void	setId(String id)	Unique identifier for the object.
void	setLivemode(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(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setStatus(String status)	Current status of the dispute.
void	setTransaction(String id)
void	setTransactionObject(Transaction expandableObject)
void	setTreasury(Dispute.Treasury treasury)	Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
Dispute	submit()	Submits an Issuing Dispute to the card network.
Dispute	submit(RequestOptions options)	Submits an Issuing Dispute to the card network.
Dispute	submit(DisputeSubmitParams params)	Submits an Issuing Dispute to the card network.
Dispute	submit(DisputeSubmitParams params, RequestOptions options)	Submits an Issuing Dispute to the card network.
Dispute	submit(Map<String,Object> params)	Submits an Issuing Dispute to the card network.
Dispute	submit(Map<String,Object> params, RequestOptions options)	Submits an Issuing Dispute to the card network.
Dispute	update(DisputeUpdateParams params)	Updates the specified Issuing Dispute object by setting the values of the parameters passed.
Dispute	update(DisputeUpdateParams params, RequestOptions options)	Updates the specified Issuing Dispute object by setting the values of the parameters passed.
Dispute	update(Map<String,Object> params)	Updates the specified Issuing Dispute object by setting the values of the parameters passed.
Dispute	update(Map<String,Object> params, RequestOptions options)	Updates the specified Issuing Dispute object by setting the values of the parameters passed.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, 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.StripeActiveObject

trySetResponseGetter

Methods inherited from interface com.stripe.model.StripeObjectInterface

getLastResponse, setLastResponse

Constructor Details

Dispute

public Dispute()

Method Details

getTransaction

public String getTransaction()

Get ID of expandable transaction object.

setTransaction

public void setTransaction(String id)

getTransactionObject

public Transaction getTransactionObject()

Get expanded transaction.

setTransactionObject

public void setTransactionObject(Transaction expandableObject)

create

public static Dispute create(Map<String,Object> params)
                      throws StripeException

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

Throws:

StripeException

create

public static Dispute create(Map<String,Object> params,
 RequestOptions options)
                      throws StripeException

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

Throws:

StripeException

create

public static Dispute create(DisputeCreateParams params)
                      throws StripeException

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

Throws:

StripeException

create

public static Dispute create(DisputeCreateParams params,
 RequestOptions options)
                      throws StripeException

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

Throws:

StripeException

list

public static DisputeCollection list(Map<String,Object> params)
                              throws StripeException

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static DisputeCollection list(Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static DisputeCollection list(DisputeListParams params)
                              throws StripeException

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

list

public static DisputeCollection list(DisputeListParams params,
 RequestOptions options)
                              throws StripeException

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Throws:

StripeException

retrieve

public static Dispute retrieve(String dispute)
                        throws StripeException

Retrieves an Issuing Dispute object.

Throws:

StripeException

retrieve

public static Dispute retrieve(String dispute,
 RequestOptions options)
                        throws StripeException

Retrieves an Issuing Dispute object.

Throws:

StripeException

retrieve

public static Dispute retrieve(String dispute,
 Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Retrieves an Issuing Dispute object.

Throws:

StripeException

retrieve

public static Dispute retrieve(String dispute,
 DisputeRetrieveParams params,
 RequestOptions options)
                        throws StripeException

Retrieves an Issuing Dispute object.

Throws:

StripeException

submit

public Dispute submit()
               throws StripeException

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Throws:

StripeException

submit

public Dispute submit(RequestOptions options)
               throws StripeException

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Throws:

StripeException

submit

public Dispute submit(Map<String,Object> params)
               throws StripeException

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Throws:

StripeException

submit

public Dispute submit(Map<String,Object> params,
 RequestOptions options)
               throws StripeException

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Throws:

StripeException

submit

public Dispute submit(DisputeSubmitParams params)
               throws StripeException

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Throws:

StripeException

submit

public Dispute submit(DisputeSubmitParams params,
 RequestOptions options)
               throws StripeException

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

Throws:

StripeException

update

public Dispute update(Map<String,Object> params)
               throws StripeException

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

Specified by:

update in interface MetadataStore<Dispute>

Throws:

StripeException

update

public Dispute update(Map<String,Object> params,
 RequestOptions options)
               throws StripeException

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

Specified by:

update in interface MetadataStore<Dispute>

Throws:

StripeException

update

public Dispute update(DisputeUpdateParams params)
               throws StripeException

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

Throws:

StripeException

update

public Dispute update(DisputeUpdateParams params,
 RequestOptions options)
               throws StripeException

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getAmount

public Long getAmount()

Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).

getBalanceTransactions

public List<BalanceTransaction> getBalanceTransactions()

List of balance transactions associated with the dispute.

getCreated

public Long getCreated()

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

getCurrency

public String getCurrency()

The currency the transaction was made in.

getEvidence

public Dispute.Evidence getEvidence()

getLivemode

public Boolean getLivemode()

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

getObject

public String getObject()

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

Equal to issuing.dispute.

getStatus

public String getStatus()

Current status of the dispute.

One of expired, lost, submitted, unsubmitted, or won.

getTreasury

public Dispute.Treasury getTreasury()

Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts

setAmount

public void setAmount(Long amount)

Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).

setBalanceTransactions

public void setBalanceTransactions(List<BalanceTransaction> balanceTransactions)

List of balance transactions associated with the dispute.

setCreated

public void setCreated(Long created)

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

setCurrency

public void setCurrency(String currency)

The currency the transaction was made in.

setEvidence

public void setEvidence(Dispute.Evidence evidence)

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(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(Map<String,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.

setObject

public void setObject(String object)

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

Equal to issuing.dispute.

setStatus

public void setStatus(String status)

Current status of the dispute.

One of expired, lost, submitted, unsubmitted, or won.

setTreasury

public void setTreasury(Dispute.Treasury treasury)

Treasury details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId

getMetadata

public Map<String,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>