Package com.stripe.model.treasury

Class CreditReversal

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.treasury.CreditReversal

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class CreditReversal
extends ApiResource
implements HasId

Legacy CreditReversals are part of the v1 version of Treasury for platforms and do not support many of the features introduced in Treasury for platforms v2. Use Received Credits instead of building a new v1 integration.

You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreditReversal.StatusTransitions	For more details about StatusTransitions, please refer to the API Reference.

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static CreditReversal	create(CreditReversalCreateParams params)	Reverses a ReceivedCredit and creates a CreditReversal object.
static CreditReversal	create(CreditReversalCreateParams params, RequestOptions options)	Reverses a ReceivedCredit and creates a CreditReversal object.
static CreditReversal	create(Map<String,Object> params)	Reverses a ReceivedCredit and creates a CreditReversal object.
static CreditReversal	create(Map<String,Object> params, RequestOptions options)	Reverses a ReceivedCredit and creates a CreditReversal object.
boolean	equals(Object o)
Long	getAmount()	Amount (in cents) transferred.
Long	getCreated()	Time at which the object was created.
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getFinancialAccount()	The FinancialAccount to reverse funds from.
String	getHostedRegulatoryReceiptUrl()	A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	If the object exists in live mode, the value is true.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getNetwork()	The rails used to reverse the funds.
String	getObject()	String representing the object's type.
String	getReceivedCredit()	The ReceivedCredit being reversed.
String	getStatus()	Status of the CreditReversal
CreditReversal.StatusTransitions	getStatusTransitions()
String	getTransaction()	Get ID of expandable transaction object.
Transaction	getTransactionObject()	Get expanded transaction.
int	hashCode()
static CreditReversalCollection	list(CreditReversalListParams params)	Returns a list of CreditReversals.
static CreditReversalCollection	list(CreditReversalListParams params, RequestOptions options)	Returns a list of CreditReversals.
static CreditReversalCollection	list(Map<String,Object> params)	Returns a list of CreditReversals.
static CreditReversalCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of CreditReversals.
static CreditReversal	retrieve(String creditReversal)	Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
static CreditReversal	retrieve(String creditReversal, RequestOptions options)	Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
static CreditReversal	retrieve(String creditReversal, CreditReversalRetrieveParams params, RequestOptions options)	Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
static CreditReversal	retrieve(String creditReversal, Map<String,Object> params, RequestOptions options)	Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.
void	setAmount(Long amount)	Amount (in cents) transferred.
void	setCreated(Long created)	Time at which the object was created.
void	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
void	setFinancialAccount(String financialAccount)	The FinancialAccount to reverse funds from.
void	setHostedRegulatoryReceiptUrl(String hostedRegulatoryReceiptUrl)	A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	If the object exists in live mode, the value is true.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
void	setNetwork(String network)	The rails used to reverse the funds.
void	setObject(String object)	String representing the object's type.
void	setReceivedCredit(String receivedCredit)	The ReceivedCredit being reversed.
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)	Status of the CreditReversal
void	setStatusTransitions(CreditReversal.StatusTransitions statusTransitions)
void	setTransaction(String id)
void	setTransactionObject(Transaction expandableObject)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

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

Constructor Details

CreditReversal

public CreditReversal()

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 CreditReversal create(Map<String,Object> params)
                             throws StripeException

Reverses a ReceivedCredit and creates a CreditReversal object.

Throws:

StripeException

create

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

Reverses a ReceivedCredit and creates a CreditReversal object.

Throws:

StripeException

create

public static CreditReversal create(CreditReversalCreateParams params)
                             throws StripeException

Reverses a ReceivedCredit and creates a CreditReversal object.

Throws:

StripeException

create

public static CreditReversal create(CreditReversalCreateParams params,
 RequestOptions options)
                             throws StripeException

Reverses a ReceivedCredit and creates a CreditReversal object.

Throws:

StripeException

list

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

Returns a list of CreditReversals.

Throws:

StripeException

list

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

Returns a list of CreditReversals.

Throws:

StripeException

list

public static CreditReversalCollection list(CreditReversalListParams params)
                                     throws StripeException

Returns a list of CreditReversals.

Throws:

StripeException

list

public static CreditReversalCollection list(CreditReversalListParams params,
 RequestOptions options)
                                     throws StripeException

Returns a list of CreditReversals.

Throws:

StripeException

retrieve

public static CreditReversal retrieve(String creditReversal)
                               throws StripeException

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.

Throws:

StripeException

retrieve

public static CreditReversal retrieve(String creditReversal,
 RequestOptions options)
                               throws StripeException

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.

Throws:

StripeException

retrieve

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

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.

Throws:

StripeException

retrieve

public static CreditReversal retrieve(String creditReversal,
 CreditReversalRetrieveParams params,
 RequestOptions options)
                               throws StripeException

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list.

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

Amount (in cents) transferred.

getCreated

public Long getCreated()

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

getCurrency

public String getCurrency()

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

getFinancialAccount

public String getFinancialAccount()

The FinancialAccount to reverse funds from.

getHostedRegulatoryReceiptUrl

public String getHostedRegulatoryReceiptUrl()

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

getLivemode

public Boolean getLivemode()

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

getNetwork

public String getNetwork()

The rails used to reverse the funds.

One of ach, or stripe.

getObject

public String getObject()

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

Equal to treasury.credit_reversal.

getReceivedCredit

public String getReceivedCredit()

The ReceivedCredit being reversed.

getStatus

public String getStatus()

Status of the CreditReversal

One of canceled, posted, or processing.

getStatusTransitions

public CreditReversal.StatusTransitions getStatusTransitions()

setAmount

public void setAmount(Long amount)

Amount (in cents) transferred.

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)

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

setFinancialAccount

public void setFinancialAccount(String financialAccount)

The FinancialAccount to reverse funds from.

setHostedRegulatoryReceiptUrl

public void setHostedRegulatoryReceiptUrl(String hostedRegulatoryReceiptUrl)

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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.

setNetwork

public void setNetwork(String network)

The rails used to reverse the funds.

One of ach, or stripe.

setObject

public void setObject(String object)

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

Equal to treasury.credit_reversal.

setReceivedCredit

public void setReceivedCredit(String receivedCredit)

The ReceivedCredit being reversed.

setStatus

public void setStatus(String status)

Status of the CreditReversal

One of canceled, posted, or processing.

setStatusTransitions

public void setStatusTransitions(CreditReversal.StatusTransitions statusTransitions)

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