Class: Stripe::SharedPayment::GrantedToken

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/shared_payment/granted_token.rb

Overview

SharedPaymentGrantedToken is the view-only resource of a SharedPaymentIssuedToken, which is a limited-use reference to a PaymentMethod. When another Stripe merchant shares a SharedPaymentIssuedToken with you, you can view attributes of the shared token using the SharedPaymentGrantedToken API, and use it with a PaymentIntent.

Defined Under Namespace

Classes: AgentDetails, PaymentMethodDetails, RiskDetails, TestHelpers, UsageDetails, UsageLimits

Constant Summary collapse

OBJECT_NAME = 
"shared_payment.granted_token"

Constants inherited from Stripe::StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from Stripe::StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

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 Stripe::StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #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

#agent_details ⇒ Object (readonly)

Details about the agent that issued this SharedPaymentGrantedToken.



1693
1694
1695
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1693

def agent_details
  @agent_details
end

#created ⇒ Object (readonly)

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



1675
1676
1677
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1675

def created
  @created
end

#deactivated_at ⇒ Object (readonly)

Time at which this SharedPaymentGrantedToken expires and can no longer be used to confirm a PaymentIntent.



1677
1678
1679
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1677

def deactivated_at
  @deactivated_at
end

#deactivated_reason ⇒ Object (readonly)

The reason why the SharedPaymentGrantedToken has been deactivated.



1679
1680
1681
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1679

def deactivated_reason
  @deactivated_reason
end

#id ⇒ Object (readonly)

Unique identifier for the object.



1681
1682
1683
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1681

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



1683
1684
1685
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1683

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



1685
1686
1687
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1685

def object
  @object
end

#payment_method_details ⇒ Object (readonly)

Details of the PaymentMethod that was shared via this token.



1695
1696
1697
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1695

def payment_method_details
  @payment_method_details
end

#risk_details ⇒ Object (readonly)

Risk details of the SharedPaymentGrantedToken.



1697
1698
1699
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1697

def risk_details
  @risk_details
end

#shared_metadata ⇒ Object (readonly)

Metadata about the SharedPaymentGrantedToken.



1687
1688
1689
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1687

def shared_metadata
  @shared_metadata
end

#usage_details ⇒ Object (readonly)

Some details about how the SharedPaymentGrantedToken has been used already.



1689
1690
1691
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1689

def usage_details
  @usage_details
end

#usage_limits ⇒ Object (readonly)

Limits on how this SharedPaymentGrantedToken can be used.



1691
1692
1693
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1691

def usage_limits
  @usage_limits
end

Class Method Details

.field_remappings ⇒ Object 



1750
1751
1752
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1750

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1740

def self.inner_class_types
  @inner_class_types = {
    usage_details: UsageDetails,
    usage_limits: UsageLimits,
    agent_details: AgentDetails,
    payment_method_details: PaymentMethodDetails,
    risk_details: RiskDetails,
  }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 10

def self.object_name
  "shared_payment.granted_token"
end

Instance Method Details

#test_helpers ⇒ Object 



1699
1700
1701
 
# File 'lib/stripe/resources/shared_payment/granted_token.rb', line 1699

def test_helpers
  TestHelpers.new(self)
end