Class: Stripe::Treasury::OutboundPaymentCreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/treasury/outbound_payment_create_params.rb

Defined Under Namespace

Classes: DestinationPaymentMethodData, DestinationPaymentMethodOptions, EndUserDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(amount: nil, currency: nil, customer: nil, description: nil, destination_payment_method: nil, destination_payment_method_data: nil, destination_payment_method_options: nil, end_user_details: nil, expand: nil, financial_account: nil, metadata: nil, statement_descriptor: nil) ⇒ OutboundPaymentCreateParams 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 161

def initialize(
  amount: nil,
  currency: nil,
  customer: nil,
  description: nil,
  destination_payment_method: nil,
  destination_payment_method_data: nil,
  destination_payment_method_options: nil,
  end_user_details: nil,
  expand: nil,
  financial_account: nil,
  metadata: nil,
  statement_descriptor: nil
)
  @amount = amount
  @currency = currency
  @customer = customer
  @description = description
  @destination_payment_method = destination_payment_method
  @destination_payment_method_data = destination_payment_method_data
  @destination_payment_method_options = destination_payment_method_options
  @end_user_details = end_user_details
  @expand = expand
   = 
  @metadata = metadata
  @statement_descriptor = statement_descriptor
end

Instance Attribute Details

#amount ⇒ Object

Amount (in cents) to be transferred.



137
138
139
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 137

def amount
  @amount
end

#currency ⇒ Object

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



139
140
141
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 139

def currency
  @currency
end

#customer ⇒ Object

ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the destination_payment_method passed in.



141
142
143
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 141

def customer
  @customer
end

#description ⇒ Object

An arbitrary string attached to the object. Often useful for displaying to users.



143
144
145
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 143

def description
  @description
end

#destination_payment_method ⇒ Object

The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with destination_payment_method_data.



145
146
147
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 145

def destination_payment_method
  @destination_payment_method
end

#destination_payment_method_data ⇒ Object

Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with destination_payment_method.



147
148
149
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 147

def destination_payment_method_data
  @destination_payment_method_data
end

#destination_payment_method_options ⇒ Object

Payment method-specific configuration for this OutboundPayment.



149
150
151
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 149

def destination_payment_method_options
  @destination_payment_method_options
end

#end_user_details ⇒ Object

End user details.



151
152
153
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 151

def end_user_details
  @end_user_details
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



153
154
155
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 153

def expand
  @expand
end

#financial_account ⇒ Object

The FinancialAccount to pull funds from.



155
156
157
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 155

def 
  
end

#metadata ⇒ Object

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.



157
158
159
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 157

def metadata
  @metadata
end

#statement_descriptor ⇒ Object

The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for ach payments, 140 characters for us_domestic_wire payments, or 500 characters for stripe network transfers. Can only include -#.$&*, spaces, and alphanumeric characters. The default value is "payment".



159
160
161
 
# File 'lib/stripe/params/treasury/outbound_payment_create_params.rb', line 159

def statement_descriptor
  @statement_descriptor
end