Class: Stripe::V2::MoneyManagement::PayoutMethod

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/money_management/payout_method.rb

Overview

Use the PayoutMethods API to list and interact with PayoutMethod objects.

Defined Under Namespace

Classes: AlternativeReference, BankAccount, Card, UsageStatus

Constant Summary collapse

OBJECT_NAME = 
"v2.money_management.payout_method"

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

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

#alternative_reference ⇒ Object (readonly)

The alternative reference for this payout method, if it’s a projected payout method.



105
106
107
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 105

def alternative_reference
  @alternative_reference
end

#available_payout_speeds ⇒ Object (readonly)

A set of available payout speeds for this payout method.



107
108
109
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 107

def available_payout_speeds
  @available_payout_speeds
end

#bank_account ⇒ Object (readonly)

The PayoutMethodBankAccount object details.



109
110
111
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 109

def 
  @bank_account
end

#card ⇒ Object (readonly)

The PayoutMethodCard object details.



111
112
113
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 111

def card
  @card
end

#created ⇒ Object (readonly)

Created timestamp.



113
114
115
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 113

def created
  @created
end

#id ⇒ Object (readonly)

ID of the PayoutMethod object.



115
116
117
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 115

def id
  @id
end

#latest_outbound_setup_intent ⇒ Object (readonly)

ID of the underlying active OutboundSetupIntent object, if any.



117
118
119
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 117

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



119
120
121
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 119

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



121
122
123
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 121

def object
  @object
end

#restricted ⇒ Object (readonly)

Whether the Payout Method is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.



124
125
126
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 124

def restricted
  @restricted
end

#type ⇒ Object (readonly)

Closed Enum. The type of payout method.



126
127
128
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 126

def type
  @type
end

#usage_status ⇒ Object (readonly)

Indicates whether the payout method has met the necessary requirements for outbound money movement.



128
129
130
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 128

def usage_status
  @usage_status
end

Class Method Details

.field_remappings ⇒ Object 



139
140
141
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 139

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



130
131
132
133
134
135
136
137
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 130

def self.inner_class_types
  @inner_class_types = {
    alternative_reference: AlternativeReference,
    bank_account: BankAccount,
    card: Card,
    usage_status: UsageStatus,
  }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/money_management/payout_method.rb', line 10

def self.object_name
  "v2.money_management.payout_method"
end