Package com.stripe.param.giftcards

Class TransactionCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.giftcards.TransactionCreateParams

public class TransactionCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TransactionCreateParams.Builder
static class	TransactionCreateParams.CreatedBy

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

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method	Description
static TransactionCreateParams.Builder	builder()
Long	getAmount()	The amount of the transaction.
Boolean	getConfirm()	Whether this is a confirmed transaction.
TransactionCreateParams.CreatedBy	getCreatedBy()	Related objects which created this transaction.
String	getCurrency()	The currency of the transaction.
String	getDescription()	An arbitrary string attached to the object.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
String	getGiftCard()	The gift card to create a new transaction on.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getTransferGroup()	A string that identifies this transaction as part of a group.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static TransactionCreateParams.Builder builder()

getAmount

public Long getAmount()

The amount of the transaction. A negative amount deducts funds, and a positive amount adds funds.

getConfirm

public Boolean getConfirm()

Whether this is a confirmed transaction. A confirmed transaction immediately deducts from/adds to the amount_available on the gift card. Otherwise, it creates a held transaction that increments the amount_held on the gift card.

getCreatedBy

public TransactionCreateParams.CreatedBy getCreatedBy()

Related objects which created this transaction.

getCurrency

public String getCurrency()

The currency of the transaction. This must match the currency of the gift card.

getDescription

public String getDescription()

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

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getGiftCard

public String getGiftCard()

The gift card to create a new transaction on.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

getTransferGroup

public String getTransferGroup()

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