Package com.stripe.model.treasury

Class DebitReversal

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.treasury.DebitReversal

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class DebitReversal
extends ApiResource
implements HasId

Legacy DebitReversals are part of the v1 version of Treasury for platforms and do not support many of the features introduced in Treasury for platforms v2.

You can reverse some ReceivedDebits depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DebitReversal.LinkedFlows	For more details about LinkedFlows, please refer to the API Reference.
static class	DebitReversal.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
DebitReversal()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static DebitReversal	create(DebitReversalCreateParams params)	Reverses a ReceivedDebit and creates a DebitReversal object.
static DebitReversal	create(DebitReversalCreateParams params, RequestOptions options)	Reverses a ReceivedDebit and creates a DebitReversal object.
static DebitReversal	create(Map<String,Object> params)	Reverses a ReceivedDebit and creates a DebitReversal object.
static DebitReversal	create(Map<String,Object> params, RequestOptions options)	Reverses a ReceivedDebit and creates a DebitReversal 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.
DebitReversal.LinkedFlows	getLinkedFlows()	Other flows linked to a DebitReversal.
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	getReceivedDebit()	The ReceivedDebit being reversed.
String	getStatus()	Status of the DebitReversal
DebitReversal.StatusTransitions	getStatusTransitions()
String	getTransaction()	Get ID of expandable transaction object.
Transaction	getTransactionObject()	Get expanded transaction.
int	hashCode()
static DebitReversalCollection	list(DebitReversalListParams params)	Returns a list of DebitReversals.
static DebitReversalCollection	list(DebitReversalListParams params, RequestOptions options)	Returns a list of DebitReversals.
static DebitReversalCollection	list(Map<String,Object> params)	Returns a list of DebitReversals.
static DebitReversalCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of DebitReversals.
static DebitReversal	retrieve(String debitReversal)	Retrieves a DebitReversal object.
static DebitReversal	retrieve(String debitReversal, RequestOptions options)	Retrieves a DebitReversal object.
static DebitReversal	retrieve(String debitReversal, DebitReversalRetrieveParams params, RequestOptions options)	Retrieves a DebitReversal object.
static DebitReversal	retrieve(String debitReversal, Map<String,Object> params, RequestOptions options)	Retrieves a DebitReversal object.
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	setLinkedFlows(DebitReversal.LinkedFlows linkedFlows)	Other flows linked to a DebitReversal.
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	setReceivedDebit(String receivedDebit)	The ReceivedDebit 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 DebitReversal
void	setStatusTransitions(DebitReversal.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

DebitReversal

public DebitReversal()

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

Reverses a ReceivedDebit and creates a DebitReversal object.

Throws:

StripeException

create

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

Reverses a ReceivedDebit and creates a DebitReversal object.

Throws:

StripeException

create

public static DebitReversal create(DebitReversalCreateParams params)
                            throws StripeException

Reverses a ReceivedDebit and creates a DebitReversal object.

Throws:

StripeException

create

public static DebitReversal create(DebitReversalCreateParams params,
 RequestOptions options)
                            throws StripeException

Reverses a ReceivedDebit and creates a DebitReversal object.

Throws:

StripeException

list

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

Returns a list of DebitReversals.

Throws:

StripeException

list

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

Returns a list of DebitReversals.

Throws:

StripeException

list

public static DebitReversalCollection list(DebitReversalListParams params)
                                    throws StripeException

Returns a list of DebitReversals.

Throws:

StripeException

list

public static DebitReversalCollection list(DebitReversalListParams params,
 RequestOptions options)
                                    throws StripeException

Returns a list of DebitReversals.

Throws:

StripeException

retrieve

public static DebitReversal retrieve(String debitReversal)
                              throws StripeException

Retrieves a DebitReversal object.

Throws:

StripeException

retrieve

public static DebitReversal retrieve(String debitReversal,
 RequestOptions options)
                              throws StripeException

Retrieves a DebitReversal object.

Throws:

StripeException

retrieve

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

Retrieves a DebitReversal object.

Throws:

StripeException

retrieve

public static DebitReversal retrieve(String debitReversal,
 DebitReversalRetrieveParams params,
 RequestOptions options)
                              throws StripeException

Retrieves a DebitReversal object.

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.

getLinkedFlows

public DebitReversal.LinkedFlows getLinkedFlows()

Other flows linked to a DebitReversal.

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 card.

getObject

public String getObject()

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

Equal to treasury.debit_reversal.

getReceivedDebit

public String getReceivedDebit()

The ReceivedDebit being reversed.

getStatus

public String getStatus()

Status of the DebitReversal

One of failed, processing, or succeeded.

getStatusTransitions

public DebitReversal.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.

setLinkedFlows

public void setLinkedFlows(DebitReversal.LinkedFlows linkedFlows)

Other flows linked to a DebitReversal.

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 card.

setObject

public void setObject(String object)

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

Equal to treasury.debit_reversal.

setReceivedDebit

public void setReceivedDebit(String receivedDebit)

The ReceivedDebit being reversed.

setStatus

public void setStatus(String status)

Status of the DebitReversal

One of failed, processing, or succeeded.

setStatusTransitions

public void setStatusTransitions(DebitReversal.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