Package com.stripe.model.issuing
Class Transaction
java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.issuing.Transaction
- All Implemented Interfaces:
BalanceTransactionSource,HasId,MetadataStore<Transaction>,StripeActiveObject,StripeObjectInterface
public class Transaction
extends ApiResource
implements MetadataStore<Transaction>, BalanceTransactionSource
Any use of an issued card that results in funds
entering or leaving your Stripe account, such as a completed purchase or refund, is represented
by an Issuing
Transaction object.
Related guide: Issued card transactions
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classFor more details about AmountDetails, please refer to the API Reference.static classFor more details about MerchantData, please refer to the API Reference.static classFor more details about NetworkData, please refer to the API Reference.static classFor more details about PurchaseDetails, please refer to the API Reference.static classstatic classFor more details about Treasury, 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_GSONFields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanbooleanThe transaction amount, which will be reflected in your balance.Detailed breakdown of amount components.Get ID of expandableauthorizationobject.Get expandedauthorization.Get ID of expandablebalanceTransactionobject.Get expandedbalanceTransaction.getCard()Get ID of expandablecardobject.Get ID of expandablecardholderobject.Get expandedcardholder.Get expandedcard.Time at which the object was created.Three-letter ISO currency code, in lowercase.Get ID of expandabledisputeobject.Get expandeddispute.getId()Unique identifier for the object.Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.The amount that the merchant will receive, denominated inmerchant_currencyand in the smallest currency unit.The currency with which the merchant is taking payment.Set of key-value pairs that you can attach to an object.Details about the transaction, such as processing dates, set by the card network.String representing the object's type.Additional purchase information that is optionally provided by the merchant.Get ID of expandablesettlementobject.Get expandedsettlement.getToken()Get ID of expandabletokenobject.Get expandedtoken.Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accountsgetType()The nature of the transaction.The digital wallet used for this transaction.inthashCode()static TransactionCollectionlist(TransactionListParams params) Returns a list of IssuingTransactionobjects.static TransactionCollectionlist(TransactionListParams params, RequestOptions options) Returns a list of IssuingTransactionobjects.static TransactionCollectionReturns a list of IssuingTransactionobjects.static TransactionCollectionlist(Map<String, Object> params, RequestOptions options) Returns a list of IssuingTransactionobjects.static TransactionRetrieves an IssuingTransactionobject.static Transactionretrieve(String transaction, RequestOptions options) Retrieves an IssuingTransactionobject.static Transactionretrieve(String transaction, TransactionRetrieveParams params, RequestOptions options) Retrieves an IssuingTransactionobject.static TransactionRetrieves an IssuingTransactionobject.voidThe transaction amount, which will be reflected in your balance.voidsetAmountDetails(Transaction.AmountDetails amountDetails) Detailed breakdown of amount components.voidvoidsetAuthorizationObject(Authorization expandableObject) voidvoidsetBalanceTransactionObject(BalanceTransaction expandableObject) voidvoidsetCardholder(String id) voidsetCardholderObject(Cardholder expandableObject) voidsetCardObject(Card expandableObject) voidsetCreated(Long created) Time at which the object was created.voidsetCurrency(String currency) Three-letter ISO currency code, in lowercase.voidsetDispute(String id) voidsetDisputeObject(Dispute expandableObject) voidUnique identifier for the object.voidsetLivemode(Boolean livemode) Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode.voidsetMerchantAmount(Long merchantAmount) The amount that the merchant will receive, denominated inmerchant_currencyand in the smallest currency unit.voidsetMerchantCurrency(String merchantCurrency) The currency with which the merchant is taking payment.voidsetMerchantData(Transaction.MerchantData merchantData) voidsetMetadata(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.voidsetNetworkData(Transaction.NetworkData networkData) Details about the transaction, such as processing dates, set by the card network.voidString representing the object's type.voidsetPurchaseDetails(Transaction.PurchaseDetails purchaseDetails) Additional purchase information that is optionally provided by the merchant.voidsetResponseGetter(StripeResponseGetter responseGetter) Method is used by the containing object orStripeResponseGetterimplementations to set theStripeResponseGetterinstance used to make further requests.voidsetSettlement(String id) voidsetSettlementObject(Settlement expandableObject) voidvoidsetTokenObject(Token expandableObject) voidsetTreasury(Transaction.Treasury treasury) Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accountsvoidThe nature of the transaction.voidThe digital wallet used for this transaction.update(TransactionUpdateParams params) Updates the specified IssuingTransactionobject by setting the values of the parameters passed.update(TransactionUpdateParams params, RequestOptions options) Updates the specified IssuingTransactionobject by setting the values of the parameters passed.Updates the specified IssuingTransactionobject by setting the values of the parameters passed.update(Map<String, Object> params, RequestOptions options) Updates the specified IssuingTransactionobject by setting the values of the parameters passed.Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeIdMethods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.stripe.model.StripeActiveObject
trySetResponseGetterMethods inherited from interface com.stripe.model.StripeObjectInterface
getLastResponse, setLastResponse
-
Constructor Details
-
Transaction
public Transaction()
-
-
Method Details
-
getAuthorization
Get ID of expandableauthorizationobject. -
setAuthorization
-
getAuthorizationObject
Get expandedauthorization. -
setAuthorizationObject
-
getBalanceTransaction
Get ID of expandablebalanceTransactionobject. -
setBalanceTransaction
-
getBalanceTransactionObject
Get expandedbalanceTransaction. -
setBalanceTransactionObject
-
getCard
Get ID of expandablecardobject. -
setCard
-
getCardObject
Get expandedcard. -
setCardObject
-
getCardholder
Get ID of expandablecardholderobject. -
setCardholder
-
getCardholderObject
Get expandedcardholder. -
setCardholderObject
-
getDispute
Get ID of expandabledisputeobject. -
setDispute
-
getDisputeObject
Get expandeddispute. -
setDisputeObject
-
getSettlement
Get ID of expandablesettlementobject. -
setSettlement
-
getSettlementObject
Get expandedsettlement. -
setSettlementObject
-
getToken
Get ID of expandabletokenobject. -
setToken
-
getTokenObject
Get expandedtoken. -
setTokenObject
-
list
Returns a list of IssuingTransactionobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static TransactionCollection list(Map<String, Object> params, RequestOptions options) throws StripeExceptionReturns a list of IssuingTransactionobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
Returns a list of IssuingTransactionobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
list
public static TransactionCollection list(TransactionListParams params, RequestOptions options) throws StripeException Returns a list of IssuingTransactionobjects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.- Throws:
StripeException
-
retrieve
Retrieves an IssuingTransactionobject.- Throws:
StripeException
-
retrieve
public static Transaction retrieve(String transaction, RequestOptions options) throws StripeException Retrieves an IssuingTransactionobject.- Throws:
StripeException
-
retrieve
public static Transaction retrieve(String transaction, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves an IssuingTransactionobject.- Throws:
StripeException
-
retrieve
public static Transaction retrieve(String transaction, TransactionRetrieveParams params, RequestOptions options) throws StripeException Retrieves an IssuingTransactionobject.- Throws:
StripeException
-
update
Updates the specified IssuingTransactionobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
updatein interfaceMetadataStore<Transaction>- Throws:
StripeException
-
update
Updates the specified IssuingTransactionobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Specified by:
updatein interfaceMetadataStore<Transaction>- Throws:
StripeException
-
update
Updates the specified IssuingTransactionobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
update
public Transaction update(TransactionUpdateParams params, RequestOptions options) throws StripeException Updates the specified IssuingTransactionobject by setting the values of the parameters passed. Any parameters not provided will be left unchanged.- Throws:
StripeException
-
getTestHelpers
-
setResponseGetter
Description copied from interface:StripeActiveObjectMethod is used by the containing object orStripeResponseGetterimplementations to set theStripeResponseGetterinstance used to make further requests.- Specified by:
setResponseGetterin interfaceStripeActiveObject- Overrides:
setResponseGetterin classApiResource- Parameters:
responseGetter- theStripeResponseGetterinstance to use for making further requests.
-
getAmount
The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit. -
getAmountDetails
Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit. -
getCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
getCurrency
Three-letter ISO currency code, in lowercase. Must be a supported currency. -
getLivemode
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode. -
getMerchantAmount
The amount that the merchant will receive, denominated inmerchant_currencyand in the smallest currency unit. It will be different fromamountif the merchant is taking payment in a different currency. -
getMerchantCurrency
The currency with which the merchant is taking payment. -
getMerchantData
-
getNetworkData
Details about the transaction, such as processing dates, set by the card network. -
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
issuing.transaction. -
getPurchaseDetails
Additional purchase information that is optionally provided by the merchant. -
getTreasury
Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts -
getType
The nature of the transaction.One of
capture, orrefund. -
getWallet
The digital wallet used for this transaction. One ofapple_pay,google_pay, orsamsung_pay. -
setAmount
The transaction amount, which will be reflected in your balance. This amount is in your currency and in the smallest currency unit. -
setAmountDetails
Detailed breakdown of amount components. These amounts are denominated incurrencyand in the smallest currency unit. -
setCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
setCurrency
Three-letter ISO currency code, in lowercase. Must be a supported currency. -
setId
Unique identifier for the object. -
setLivemode
Has the valuetrueif the object exists in live mode or the valuefalseif the object exists in test mode. -
setMerchantAmount
The amount that the merchant will receive, denominated inmerchant_currencyand in the smallest currency unit. It will be different fromamountif the merchant is taking payment in a different currency. -
setMerchantCurrency
The currency with which the merchant is taking payment. -
setMerchantData
-
setMetadata
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. -
setNetworkData
Details about the transaction, such as processing dates, set by the card network. -
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
issuing.transaction. -
setPurchaseDetails
Additional purchase information that is optionally provided by the merchant. -
setTreasury
Treasury details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts -
setType
The nature of the transaction.One of
capture, orrefund. -
setWallet
The digital wallet used for this transaction. One ofapple_pay,google_pay, orsamsung_pay. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object. -
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:
getMetadatain interfaceMetadataStore<Transaction>
-