Package com.stripe.model.giftcards

Class Transaction

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.giftcards.Transaction

All Implemented Interfaces:

HasId, MetadataStore<Transaction>, StripeObjectInterface

public class Transaction
extends ApiResource
implements HasId, MetadataStore<Transaction>

A gift card transaction represents a single transaction on a referenced gift card. A transaction is in one of three states, confirmed, held or canceled. A confirmed transaction is one that has added/deducted funds. A held transaction has created a temporary hold on funds, which can then be cancelled or confirmed. A held transaction can be confirmed into a confirmed transaction, or canceled into a canceled transaction. A canceled transaction has no effect on a gift card's balance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Transaction.CreatedBy

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

ApiResource.RequestMethod

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

Method Summary

Modifier and Type	Method	Description
Transaction	cancel()	Cancel a gift card transaction.
Transaction	cancel(RequestOptions options)	Cancel a gift card transaction.
Transaction	cancel(TransactionCancelParams params)	Cancel a gift card transaction.
Transaction	cancel(TransactionCancelParams params, RequestOptions options)	Cancel a gift card transaction.
Transaction	cancel(Map<String,Object> params)	Cancel a gift card transaction.
Transaction	cancel(Map<String,Object> params, RequestOptions options)	Cancel a gift card transaction.
protected boolean	canEqual(Object other)
Transaction	confirm()	Confirm a gift card transaction.
Transaction	confirm(RequestOptions options)	Confirm a gift card transaction.
Transaction	confirm(TransactionConfirmParams params)	Confirm a gift card transaction.
Transaction	confirm(TransactionConfirmParams params, RequestOptions options)	Confirm a gift card transaction.
Transaction	confirm(Map<String,Object> params)	Confirm a gift card transaction.
Transaction	confirm(Map<String,Object> params, RequestOptions options)	Confirm a gift card transaction.
static Transaction	create(TransactionCreateParams params)	Create a gift card transaction.
static Transaction	create(TransactionCreateParams params, RequestOptions options)	Create a gift card transaction.
static Transaction	create(Map<String,Object> params)	Create a gift card transaction.
static Transaction	create(Map<String,Object> params, RequestOptions options)	Create a gift card transaction.
boolean	equals(Object o)
Long	getAmount()	The amount of this transaction.
Long	getConfirmedAt()	Time at which the transaction was confirmed.
Long	getCreated()	Time at which the object was created.
Transaction.CreatedBy	getCreatedBy()	The related Stripe objects that created this gift card transaction.
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getDescription()	An arbitrary string attached to the object.
String	getGiftCard()	The gift card that this transaction occurred on.
String	getId()	Unique identifier for the object.
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()	Status of this transaction, one of held, confirmed, or canceled.
String	getTransferGroup()	A string that identifies this transaction as part of a group.
int	hashCode()
static TransactionCollection	list(TransactionListParams params)	List gift card transactions for a gift card.
static TransactionCollection	list(TransactionListParams params, RequestOptions options)	List gift card transactions for a gift card.
static TransactionCollection	list(Map<String,Object> params)	List gift card transactions for a gift card.
static TransactionCollection	list(Map<String,Object> params, RequestOptions options)	List gift card transactions for a gift card.
static Transaction	retrieve(String id)	Retrieves the gift card transaction.
static Transaction	retrieve(String id, RequestOptions options)	Retrieves the gift card transaction.
static Transaction	retrieve(String id, TransactionRetrieveParams params, RequestOptions options)	Retrieves the gift card transaction.
static Transaction	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves the gift card transaction.
void	setAmount(Long amount)	The amount of this transaction.
void	setConfirmedAt(Long confirmedAt)	Time at which the transaction was confirmed.
void	setCreated(Long created)	Time at which the object was created.
void	setCreatedBy(Transaction.CreatedBy createdBy)	The related Stripe objects that created this gift card transaction.
void	setCurrency(String currency)	Three-letter ISO currency code, in lowercase.
void	setDescription(String description)	An arbitrary string attached to the object.
void	setGiftCard(String giftCard)	The gift card that this transaction occurred on.
void	setId(String id)	Unique identifier for the object.
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	setStatus(String status)	Status of this transaction, one of held, confirmed, or canceled.
void	setTransferGroup(String transferGroup)	A string that identifies this transaction as part of a group.
Transaction	update(TransactionUpdateParams params)	Update a gift card transaction.
Transaction	update(TransactionUpdateParams params, RequestOptions options)	Update a gift card transaction.
Transaction	update(Map<String,Object> params)	Update a gift card transaction.
Transaction	update(Map<String,Object> params, RequestOptions options)	Update a gift card transaction.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, classUrl, classUrl, fullUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Transaction

public Transaction()

Method Details

cancel

public Transaction cancel()
                   throws StripeException

Cancel a gift card transaction.

Throws:

StripeException

cancel

public Transaction cancel(RequestOptions options)
                   throws StripeException

Cancel a gift card transaction.

Throws:

StripeException

cancel

public Transaction cancel(Map<String,Object> params)
                   throws StripeException

Cancel a gift card transaction.

Throws:

StripeException

cancel

public Transaction cancel(Map<String,Object> params,
 RequestOptions options)
                   throws StripeException

Cancel a gift card transaction.

Throws:

StripeException

cancel

public Transaction cancel(TransactionCancelParams params)
                   throws StripeException

Cancel a gift card transaction.

Throws:

StripeException

cancel

public Transaction cancel(TransactionCancelParams params,
 RequestOptions options)
                   throws StripeException

Cancel a gift card transaction.

Throws:

StripeException

confirm

public Transaction confirm()
                    throws StripeException

Confirm a gift card transaction.

Throws:

StripeException

confirm

public Transaction confirm(RequestOptions options)
                    throws StripeException

Confirm a gift card transaction.

Throws:

StripeException

confirm

public Transaction confirm(Map<String,Object> params)
                    throws StripeException

Confirm a gift card transaction.

Throws:

StripeException

confirm

public Transaction confirm(Map<String,Object> params,
 RequestOptions options)
                    throws StripeException

Confirm a gift card transaction.

Throws:

StripeException

confirm

public Transaction confirm(TransactionConfirmParams params)
                    throws StripeException

Confirm a gift card transaction.

Throws:

StripeException

confirm

public Transaction confirm(TransactionConfirmParams params,
 RequestOptions options)
                    throws StripeException

Confirm a gift card transaction.

Throws:

StripeException

create

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

Create a gift card transaction.

Throws:

StripeException

create

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

Create a gift card transaction.

Throws:

StripeException

create

public static Transaction create(TransactionCreateParams params)
                          throws StripeException

Create a gift card transaction.

Throws:

StripeException

create

public static Transaction create(TransactionCreateParams params,
 RequestOptions options)
                          throws StripeException

Create a gift card transaction.

Throws:

StripeException

list

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

List gift card transactions for a gift card.

Throws:

StripeException

list

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

List gift card transactions for a gift card.

Throws:

StripeException

list

public static TransactionCollection list(TransactionListParams params)
                                  throws StripeException

List gift card transactions for a gift card.

Throws:

StripeException

list

public static TransactionCollection list(TransactionListParams params,
 RequestOptions options)
                                  throws StripeException

List gift card transactions for a gift card.

Throws:

StripeException

retrieve

public static Transaction retrieve(String id)
                            throws StripeException

Retrieves the gift card transaction.

Throws:

StripeException

retrieve

public static Transaction retrieve(String id,
 RequestOptions options)
                            throws StripeException

Retrieves the gift card transaction.

Throws:

StripeException

retrieve

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

Retrieves the gift card transaction.

Throws:

StripeException

retrieve

public static Transaction retrieve(String id,
 TransactionRetrieveParams params,
 RequestOptions options)
                            throws StripeException

Retrieves the gift card transaction.

Throws:

StripeException

update

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

Update a gift card transaction.

Specified by:

update in interface MetadataStore<Transaction>

Throws:

StripeException

update

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

Update a gift card transaction.

Specified by:

update in interface MetadataStore<Transaction>

Throws:

StripeException

update

public Transaction update(TransactionUpdateParams params)
                   throws StripeException

Update a gift card transaction.

Throws:

StripeException

update

public Transaction update(TransactionUpdateParams params,
 RequestOptions options)
                   throws StripeException

Update a gift card transaction.

Throws:

StripeException

getAmount

public Long getAmount()

The amount of this transaction. A positive value indicates that funds were added to the gift card. A negative value indicates that funds were removed from the gift card.

getConfirmedAt

public Long getConfirmedAt()

Time at which the transaction was confirmed. Measured in seconds since the Unix epoch.

getCreated

public Long getCreated()

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

getCreatedBy

public Transaction.CreatedBy getCreatedBy()

The related Stripe objects that created this gift card transaction.

getCurrency

public String getCurrency()

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

getDescription

public String getDescription()

An arbitrary string attached to the object. Often useful for displaying to users.

getGiftCard

public String getGiftCard()

The gift card that this transaction occurred on.

getObject

public String getObject()

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

Equal to gift_cards.transaction.

getStatus

public String getStatus()

Status of this transaction, one of held, confirmed, or canceled.

getTransferGroup

public String getTransferGroup()

A string that identifies this transaction as part of a group. See the Connect documentation for details.

setAmount

public void setAmount(Long amount)

The amount of this transaction. A positive value indicates that funds were added to the gift card. A negative value indicates that funds were removed from the gift card.

setConfirmedAt

public void setConfirmedAt(Long confirmedAt)

Time at which the transaction was confirmed. Measured in seconds since the Unix epoch.

setCreated

public void setCreated(Long created)

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

setCreatedBy

public void setCreatedBy(Transaction.CreatedBy createdBy)

The related Stripe objects that created this gift card transaction.

setCurrency

public void setCurrency(String currency)

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

setDescription

public void setDescription(String description)

An arbitrary string attached to the object. Often useful for displaying to users.

setGiftCard

public void setGiftCard(String giftCard)

The gift card that this transaction occurred on.

setId

public void setId(String id)

Unique identifier for the object.

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 gift_cards.transaction.

setStatus

public void setStatus(String status)

Status of this transaction, one of held, confirmed, or canceled.

setTransferGroup

public void setTransferGroup(String transferGroup)

A string that identifies this transaction as part of a group. See the Connect documentation for details.

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<Transaction>