Package com.stripe.model

Class Refund

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Refund

All Implemented Interfaces:

HasId, MetadataStore<Charge>

public class Refund
extends APIResource
implements MetadataStore<Charge>, HasId

Nested Class Summary

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

APIResource.RequestMethod, APIResource.RequestType

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
Refund()

Method Summary

Modifier and Type	Method	Description
static RefundCollection	all(java.util.Map<java.lang.String,java.lang.Object> params)	Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.
static RefundCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Refund	create(java.util.Map<java.lang.String,java.lang.Object> params)	Create a refund.
static Refund	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Create a refund.
boolean	equals(java.lang.Object o)
java.lang.Long	getAmount()
java.lang.String	getBalanceTransaction()
BalanceTransaction	getBalanceTransactionObject()
java.lang.String	getCharge()
Charge	getChargeObject()
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.String	getDescription()
java.lang.String	getId()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getObject()
java.lang.String	getReason()
java.lang.String	getReceiptNumber()
java.lang.String	getStatus()
int	hashCode()
static RefundCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	List all refunds.
static RefundCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	List all refunds.
static Refund	retrieve(java.lang.String id)	Retrieve a refund.
static Refund	retrieve(java.lang.String id, RequestOptions options)	Retrieve a refund.
static Refund	retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieve a refund.
void	setAmount(java.lang.Long amount)
void	setBalanceTransaction(java.lang.String balanceTransactionID)
void	setBalanceTransactionObject(BalanceTransaction c)
void	setCharge(java.lang.String chargeID)
void	setChargeObject(Charge c)
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setDescription(java.lang.String description)
void	setId(java.lang.String id)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setObject(java.lang.String object)
void	setReason(java.lang.String reason)
void	setReceiptNumber(java.lang.String receiptNumber)
void	setStatus(java.lang.String status)
Refund	update(java.util.Map<java.lang.String,java.lang.Object> params)	Update a refund.
Refund	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Update a refund.
Refund	update(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Methods inherited from class com.stripe.net.APIResource

classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Constructor Detail

Refund

public Refund()

Method Detail

getBalanceTransaction

public java.lang.String getBalanceTransaction()

setBalanceTransaction

public void setBalanceTransaction(java.lang.String balanceTransactionID)

getBalanceTransactionObject

public BalanceTransaction getBalanceTransactionObject()

setBalanceTransactionObject

public void setBalanceTransactionObject(BalanceTransaction c)

getCharge

public java.lang.String getCharge()

setCharge

public void setCharge(java.lang.String chargeID)

getChargeObject

public Charge getChargeObject()

setChargeObject

public void setChargeObject(Charge c)

all

@Deprecated
public static RefundCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List all refunds.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static RefundCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                   RequestOptions options)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all refunds.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Refund create(java.util.Map<java.lang.String,java.lang.Object> params)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Create a refund.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Refund create(java.util.Map<java.lang.String,java.lang.Object> params,
                            RequestOptions options)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Create a refund.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static RefundCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

List all refunds.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static RefundCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

List all refunds.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Refund retrieve(java.lang.String id)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Retrieve a refund.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Refund retrieve(java.lang.String id,
                              RequestOptions options)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Retrieve a refund.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Refund retrieve(java.lang.String id,
                              java.util.Map<java.lang.String,java.lang.Object> params,
                              RequestOptions options)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Retrieve a refund.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Refund update(java.util.Map<java.lang.String,java.lang.Object> params)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Update a refund.

Specified by:

update in interface MetadataStore<Charge>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Refund update(java.util.Map<java.lang.String,java.lang.Object> params,
                     RequestOptions options)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Update a refund.

Specified by:

update in interface MetadataStore<Charge>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

@Deprecated
public Refund update(java.util.Map<java.lang.String,java.lang.Object> params,
                     java.lang.String apiKey)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Update a refund.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getAmount

public java.lang.Long getAmount()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getDescription

public java.lang.String getDescription()

getReason

public java.lang.String getReason()

getReceiptNumber

public java.lang.String getReceiptNumber()

getStatus

public java.lang.String getStatus()

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setAmount

public void setAmount(java.lang.Long amount)

setCreated

public void setCreated(java.lang.Long created)

setCurrency

public void setCurrency(java.lang.String currency)

setDescription

public void setDescription(java.lang.String description)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setReason

public void setReason(java.lang.String reason)

setReceiptNumber

public void setReceiptNumber(java.lang.String receiptNumber)

setStatus

public void setStatus(java.lang.String status)

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

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface MetadataStore<Charge>