Class: Stripe::Issuing::Transaction

Inherits:
APIResource show all
Extended by:
APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/issuing/transaction.rb

Overview

Any use of an [issued card](stripe.com/docs/issuing) 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](stripe.com/docs/issuing/purchases/transactions)

Defined Under Namespace

Classes: AmountDetails, CreateForceCaptureParams, CreateUnlinkedRefundParams, ListParams, MerchantData, NetworkData, PurchaseDetails, RefundParams, TestHelpers, Treasury, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"issuing.transaction"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amount ⇒ Object (readonly)

The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



1029
1030
1031
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1029

def amount
  @amount
end

#amount_details ⇒ Object (readonly)

Detailed breakdown of amount components. These amounts are denominated in ‘currency` and in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



1031
1032
1033
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1031

def amount_details
  @amount_details
end

#authorization ⇒ Object (readonly)

The ‘Authorization` object that led to this transaction.



1033
1034
1035
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1033

def authorization
  @authorization
end

#balance_transaction ⇒ Object (readonly)

ID of the [balance transaction](stripe.com/docs/api/balance_transactions) associated with this transaction.



1035
1036
1037
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1035

def balance_transaction
  @balance_transaction
end

#card ⇒ Object (readonly)

The card used to make this transaction.



1037
1038
1039
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1037

def card
  @card
end

#cardholder ⇒ Object (readonly)

The cardholder to whom this transaction belongs.



1039
1040
1041
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1039

def cardholder
  @cardholder
end

#created ⇒ Object (readonly)

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



1041
1042
1043
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1041

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



1043
1044
1045
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1043

def currency
  @currency
end

#dispute ⇒ Object (readonly)

If you’ve disputed the transaction, the ID of the dispute.



1045
1046
1047
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1045

def dispute
  @dispute
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1047
1048
1049
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1047

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



1049
1050
1051
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1049

def livemode
  @livemode
end

#merchant_amount ⇒ Object (readonly)

The amount that the merchant will receive, denominated in ‘merchant_currency` and in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.



1051
1052
1053
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1051

def merchant_amount
  @merchant_amount
end

#merchant_currency ⇒ Object (readonly)

The currency with which the merchant is taking payment.



1053
1054
1055
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1053

def merchant_currency
  @merchant_currency
end

#merchant_data ⇒ Object (readonly)

Attribute for field merchant_data



1055
1056
1057
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1055

def merchant_data
  @merchant_data
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



1057
1058
1059
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1057

def metadata
  @metadata
end

#network_data ⇒ Object (readonly)

Details about the transaction, such as processing dates, set by the card network.



1059
1060
1061
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1059

def network_data
  @network_data
end

#object ⇒ Object (readonly)

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



1061
1062
1063
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1061

def object
  @object
end

#purchase_details ⇒ Object (readonly)

Additional purchase information that is optionally provided by the merchant.



1063
1064
1065
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1063

def purchase_details
  @purchase_details
end

#settlement ⇒ Object (readonly)

The ID of the [settlement](stripe.com/docs/api/issuing/settlements) to which this transaction belongs.



1065
1066
1067
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1065

def settlement
  @settlement
end

#token ⇒ Object (readonly)

[Token](stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.



1067
1068
1069
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1067

def token
  @token
end

#treasury ⇒ Object (readonly)

[Treasury](stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts



1069
1070
1071
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1069

def treasury
  @treasury
end

#type ⇒ Object (readonly)

The nature of the transaction.



1071
1072
1073
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1071

def type
  @type
end

#wallet ⇒ Object (readonly)

The digital wallet used for this transaction. One of ‘apple_pay`, `google_pay`, or `samsung_pay`.



1073
1074
1075
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1073

def wallet
  @wallet
end

Class Method Details

.field_remappings ⇒ Object 



1156
1157
1158
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1156

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1146

def self.inner_class_types
  @inner_class_types = {
    amount_details: AmountDetails,
    merchant_data: MerchantData,
    network_data: NetworkData,
    purchase_details: PurchaseDetails,
    treasury: Treasury,
  }
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.



1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1076

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/issuing/transactions",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



16
17
18
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 16

def self.object_name
  "issuing.transaction"
end

.update(transaction, params = {}, opts = {}) ⇒ Object

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1086

def self.update(transaction, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/transactions/%<transaction>s", { transaction: CGI.escape(transaction) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#test_helpers ⇒ Object 



1095
1096
1097
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 1095

def test_helpers
  TestHelpers.new(self)
end