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, MerchantData, NetworkData, PurchaseDetails, TestHelpers, Treasury

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



325
326
327
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 325

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



327
328
329
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 327

def amount_details
  @amount_details
end

#authorization ⇒ Object (readonly)

The ‘Authorization` object that led to this transaction.



329
330
331
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 329

def authorization
  @authorization
end

#balance_transaction ⇒ Object (readonly)

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



331
332
333
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 331

def balance_transaction
  @balance_transaction
end

#card ⇒ Object (readonly)

The card used to make this transaction.



333
334
335
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 333

def card
  @card
end

#cardholder ⇒ Object (readonly)

The cardholder to whom this transaction belongs.



335
336
337
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 335

def cardholder
  @cardholder
end

#created ⇒ Object (readonly)

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



337
338
339
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 337

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



339
340
341
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 339

def currency
  @currency
end

#dispute ⇒ Object (readonly)

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



341
342
343
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 341

def dispute
  @dispute
end

#id ⇒ Object (readonly)

Unique identifier for the object.



343
344
345
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 343

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.



345
346
347
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 345

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.



347
348
349
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 347

def merchant_amount
  @merchant_amount
end

#merchant_currency ⇒ Object (readonly)

The currency with which the merchant is taking payment.



349
350
351
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 349

def merchant_currency
  @merchant_currency
end

#merchant_data ⇒ Object (readonly)

Attribute for field merchant_data



351
352
353
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 351

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.



353
354
355
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 353

def metadata
  @metadata
end

#network_data ⇒ Object (readonly)

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



355
356
357
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 355

def network_data
  @network_data
end

#object ⇒ Object (readonly)

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



357
358
359
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 357

def object
  @object
end

#purchase_details ⇒ Object (readonly)

Additional purchase information that is optionally provided by the merchant.



359
360
361
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 359

def purchase_details
  @purchase_details
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.



361
362
363
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 361

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



363
364
365
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 363

def treasury
  @treasury
end

#type ⇒ Object (readonly)

The nature of the transaction.



365
366
367
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 365

def type
  @type
end

#wallet ⇒ Object (readonly)

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



367
368
369
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 367

def wallet
  @wallet
end

Class Method Details

.field_remappings ⇒ Object 



450
451
452
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 450

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



440
441
442
443
444
445
446
447
448
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 440

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.



370
371
372
373
374
375
376
377
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 370

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.



380
381
382
383
384
385
386
387
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 380

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 



389
390
391
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 389

def test_helpers
  TestHelpers.new(self)
end