Class: Stripe::Issuing::Authorization

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

Overview

When an issued card is used to make a purchase, an Issuing Authorization object is created. Authorizations must be approved for the purchase to be completed successfully.

Related guide: Issued card authorizations

Defined Under Namespace

Classes: AmountDetails, Fleet, FraudChallenge, Fuel, MerchantData, NetworkData, PendingRequest, RequestHistory, TestHelpers, Treasury, VerificationData

Constant Summary collapse

OBJECT_NAME = 
"issuing.authorization"

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 total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. amount should be the same as merchant_amount, unless currency and merchant_currency are different.



473
474
475
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 473

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.



475
476
477
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 475

def amount_details
  @amount_details
end

#approved ⇒ Object (readonly)

Whether the authorization has been approved.



477
478
479
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 477

def approved
  @approved
end

#authorization_method ⇒ Object (readonly)

How the card details were provided.



479
480
481
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 479

def authorization_method
  @authorization_method
end

#balance_transactions ⇒ Object (readonly)

List of balance transactions associated with this authorization.



481
482
483
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 481

def balance_transactions
  @balance_transactions
end

#card ⇒ Object (readonly)

You can create physical or virtual cards that are issued to cardholders.



483
484
485
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 483

def card
  @card
end

#card_presence ⇒ Object (readonly)

Whether the card was present at the point of sale for the authorization.



485
486
487
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 485

def card_presence
  @card_presence
end

#cardholder ⇒ Object (readonly)

The cardholder to whom this authorization belongs.



487
488
489
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 487

def cardholder
  @cardholder
end

#created ⇒ Object (readonly)

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



489
490
491
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 489

def created
  @created
end

#currency ⇒ Object (readonly)

The currency of the cardholder. This currency can be different from the currency presented at authorization and the merchant_currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.



491
492
493
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 491

def currency
  @currency
end

#fleet ⇒ Object (readonly)

Fleet-specific information for authorizations using Fleet cards.



493
494
495
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 493

def fleet
  @fleet
end

#fraud_challenges ⇒ Object (readonly)

Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.



495
496
497
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 495

def fraud_challenges
  @fraud_challenges
end

#fuel ⇒ Object (readonly)

Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.



497
498
499
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 497

def fuel
  @fuel
end

#id ⇒ Object (readonly)

Unique identifier for the object.



499
500
501
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 499

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.



501
502
503
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 501

def livemode
  @livemode
end

#merchant_amount ⇒ Object (readonly)

The total amount that was authorized or rejected. This amount is in the merchant_currency and in the smallest currency unit. merchant_amount should be the same as amount, unless merchant_currency and currency are different.



503
504
505
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 503

def merchant_amount
  @merchant_amount
end

#merchant_currency ⇒ Object (readonly)

The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.



505
506
507
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 505

def merchant_currency
  @merchant_currency
end

#merchant_data ⇒ Object (readonly)

Attribute for field merchant_data



507
508
509
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 507

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.



509
510
511
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 509

def metadata
  @metadata
end

#network_data ⇒ Object (readonly)

Details about the authorization, such as identifiers, set by the card network.



511
512
513
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 511

def network_data
  @network_data
end

#object ⇒ Object (readonly)

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



513
514
515
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 513

def object
  @object
end

#pending_request ⇒ Object (readonly)

The pending authorization request. This field will only be non-null during an issuing_authorization.request webhook.



515
516
517
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 515

def pending_request
  @pending_request
end

#request_history ⇒ Object (readonly)

History of every time a pending_request authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.



517
518
519
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 517

def request_history
  @request_history
end

#status ⇒ Object (readonly)

The current status of the authorization in its lifecycle.



519
520
521
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 519

def status
  @status
end

#token ⇒ Object (readonly)

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



521
522
523
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 521

def token
  @token
end

#transactions ⇒ Object (readonly)

List of transactions associated with this authorization.



523
524
525
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 523

def transactions
  @transactions
end

#treasury ⇒ Object (readonly)

Treasury details related to this authorization if it was created on a FinancialAccount.



525
526
527
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 525

def treasury
  @treasury
end

#verification_data ⇒ Object (readonly)

Attribute for field verification_data



527
528
529
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 527

def verification_data
  @verification_data
end

#verified_by_fraud_challenge ⇒ Object (readonly)

Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.



529
530
531
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 529

def verified_by_fraud_challenge
  @verified_by_fraud_challenge
end

#wallet ⇒ Object (readonly)

The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. Will populate as null when no digital wallet was utilized.



531
532
533
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 531

def wallet
  @wallet
end

Class Method Details

.approve(authorization, params = {}, opts = {}) ⇒ Object

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.



547
548
549
550
551
552
553
554
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 547

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

.decline(authorization, params = {}, opts = {}) ⇒ Object

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.



575
576
577
578
579
580
581
582
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 575

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

.field_encodings ⇒ Object 



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 769

def self.field_encodings
  @field_encodings = {
    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: { kind: :nullable, inner: :decimal_string },
        },
      },
    },
  }
end

.field_remappings ⇒ Object 



765
766
767
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 765

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 750

def self.inner_class_types
  @inner_class_types = {
    amount_details: AmountDetails,
    fleet: Fleet,
    fraud_challenges: FraudChallenge,
    fuel: Fuel,
    merchant_data: MerchantData,
    network_data: NetworkData,
    pending_request: PendingRequest,
    request_history: RequestHistory,
    treasury: Treasury,
    verification_data: VerificationData,
  }
end

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

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



590
591
592
593
594
595
596
597
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 590

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

.object_name ⇒ Object 



17
18
19
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 17

def self.object_name
  "issuing.authorization"
end

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

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



600
601
602
603
604
605
606
607
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 600

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

Instance Method Details

#approve(params = {}, opts = {}) ⇒ Object

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.



535
536
537
538
539
540
541
542
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 535

def approve(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/authorizations/%<authorization>s/approve", { authorization: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#decline(params = {}, opts = {}) ⇒ Object

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.



563
564
565
566
567
568
569
570
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 563

def decline(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/authorizations/%<authorization>s/decline", { authorization: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#test_helpers ⇒ Object 



609
610
611
 
# File 'lib/stripe/resources/issuing/authorization.rb', line 609

def test_helpers
  TestHelpers.new(self)
end