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

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, #_get_union_variant_class, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, inner_class_union_variant_types, #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.



472
473
474
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 472

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.



474
475
476
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 474

def amount_details
  @amount_details
end

#authorization ⇒ Object (readonly)

The Authorization object that led to this transaction.



476
477
478
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 476

def authorization
  @authorization
end

#balance_transaction ⇒ Object (readonly)

ID of the balance transaction associated with this transaction.



478
479
480
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 478

def balance_transaction
  @balance_transaction
end

#card ⇒ Object (readonly)

The card used to make this transaction.



480
481
482
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 480

def card
  @card
end

#cardholder ⇒ Object (readonly)

The cardholder to whom this transaction belongs.



482
483
484
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 482

def cardholder
  @cardholder
end

#created ⇒ Object (readonly)

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



484
485
486
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 484

def created
  @created
end

#currency ⇒ Object (readonly)

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



486
487
488
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 486

def currency
  @currency
end

#dispute ⇒ Object (readonly)

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



488
489
490
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 488

def dispute
  @dispute
end

#id ⇒ Object (readonly)

Unique identifier for the object.



490
491
492
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 490

def id
  @id
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.



492
493
494
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 492

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. It will be different from amount if the merchant is taking payment in a different currency.



494
495
496
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 494

def merchant_amount
  @merchant_amount
end

#merchant_currency ⇒ Object (readonly)

The currency with which the merchant is taking payment.



496
497
498
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 496

def merchant_currency
  @merchant_currency
end

#merchant_data ⇒ Object (readonly)

Attribute for field merchant_data



498
499
500
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 498

def merchant_data
  @merchant_data
end

#metadata ⇒ Object (readonly)

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.



500
501
502
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 500

def metadata
  @metadata
end

#network_data ⇒ Object (readonly)

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



502
503
504
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 502

def network_data
  @network_data
end

#object ⇒ Object (readonly)

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



504
505
506
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 504

def object
  @object
end

#purchase_details ⇒ Object (readonly)

Additional purchase information that is optionally provided by the merchant.



506
507
508
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 506

def purchase_details
  @purchase_details
end

#token ⇒ Object (readonly)

Token object used for this transaction. If a network token was not used for this transaction, this field will be null.



508
509
510
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 508

def token
  @token
end

#treasury ⇒ Object (readonly)

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



510
511
512
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 510

def treasury
  @treasury
end

#type ⇒ Object (readonly)

The nature of the transaction.



512
513
514
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 512

def type
  @type
end

#wallet ⇒ Object (readonly)

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



514
515
516
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 514

def wallet
  @wallet
end

Class Method Details

.field_encodings ⇒ Object 



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 601

def self.field_encodings
  @field_encodings = {
    purchase_details: {
      kind: :nullable,
      inner: {
        kind: :object,
        fields: {
          fleet: {
            kind: :nullable,
            inner: {
              kind: :object,
              fields: {
                reported_breakdown: {
                  kind: :nullable,
                  inner: {
                    kind: :object,
                    fields: {
                      fuel: {
                        kind: :nullable,
                        inner: {
                          kind: :object,
                          fields: {
                            gross_amount_decimal: { kind: :nullable, inner: :decimal_string },
                          },
                        },
                      },
                      non_fuel: {
                        kind: :nullable,
                        inner: {
                          kind: :object,
                          fields: {
                            gross_amount_decimal: { kind: :nullable, inner: :decimal_string },
                          },
                        },
                      },
                      tax: {
                        kind: :nullable,
                        inner: {
                          kind: :object,
                          fields: {
                            local_amount_decimal: { kind: :nullable, inner: :decimal_string },
                            national_amount_decimal: {
                              kind: :nullable,
                              inner: :decimal_string,
                            },
                          },
                        },
                      },
                    },
                  },
                },
              },
            },
          },
          fuel: {
            kind: :nullable,
            inner: {
              kind: :object,
              fields: {
                quantity_decimal: { kind: :nullable, inner: :decimal_string },
                unit_cost_decimal: :decimal_string,
              },
            },
          },
        },
      },
    },
  }
end

.field_remappings ⇒ Object 



597
598
599
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 597

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



587
588
589
590
591
592
593
594
595
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 587

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.



517
518
519
520
521
522
523
524
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 517

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.



527
528
529
530
531
532
533
534
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 527

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 



536
537
538
 
# File 'lib/stripe/resources/issuing/transaction.rb', line 536

def test_helpers
  TestHelpers.new(self)
end