Class: Stripe::V2::MoneyManagement::OutboundPayment

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

Overview

OutboundPayment represents a single money movement from one FinancialAccount you own to a payout method someone else owns.

Defined Under Namespace

Classes: Amount, DeliveryOptions, From, RecipientNotification, StatusDetails, StatusTransitions, To, TraceId

Constant Summary collapse

OBJECT_NAME = 
"v2.money_management.outbound_payment"

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

#amount ⇒ Object (readonly)

The “presentment amount” for the OutboundPayment.



199
200
201
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 199

def amount
  @amount
end

#cancelable ⇒ Object (readonly)

Returns true if the OutboundPayment can be canceled, and false otherwise.



201
202
203
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 201

def cancelable
  @cancelable
end

#created ⇒ Object (readonly)

Time at which the OutboundPayment was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.



204
205
206
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 204

def created
  @created
end

#delivery_options ⇒ Object (readonly)

Delivery options to be used to send the OutboundPayment.



206
207
208
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 206

def delivery_options
  @delivery_options
end

#description ⇒ Object (readonly)

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



208
209
210
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 208

def description
  @description
end

#expected_arrival_date ⇒ Object (readonly)

The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a ‘failed`, `canceled`, or `returned` state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.



211
212
213
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 211

def expected_arrival_date
  @expected_arrival_date
end

#from ⇒ Object (readonly)

The FinancialAccount that funds were pulled from.



213
214
215
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 213

def from
  @from
end

#id ⇒ Object (readonly)

Unique identifier for the OutboundPayment.



215
216
217
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 215

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



244
245
246
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 244

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



217
218
219
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 217

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



219
220
221
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 219

def object
  @object
end

#outbound_payment_quote ⇒ Object (readonly)

The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.



221
222
223
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 221

def outbound_payment_quote
  @outbound_payment_quote
end

#receipt_url ⇒ Object (readonly)

A link to the Stripe-hosted receipt for this OutboundPayment. The receipt link remains active for 60 days from the OutboundPayment creation date. After this period, the link will expire and the receipt url value will be null.



223
224
225
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 223

def receipt_url
  @receipt_url
end

#recipient_notification ⇒ Object (readonly)

Details about the OutboundPayment notification settings for recipient.



225
226
227
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 225

def recipient_notification
  @recipient_notification
end

#recipient_verification ⇒ Object (readonly)

The recipient verification id for this OutboundPayment. Only required for countries with regulatory mandates to verify recipient names before OutboundPayment creation.



227
228
229
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 227

def recipient_verification
  @recipient_verification
end

#statement_descriptor ⇒ Object (readonly)

The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). It will default to ‘STRIPE` if not set on the account settings.



229
230
231
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 229

def statement_descriptor
  @statement_descriptor
end

#status ⇒ Object (readonly)

Closed Enum. Current status of the OutboundPayment: ‘processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is processing. The status changes to `posted` once the OutboundPayment has been “confirmed” and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its payout method, its status will change to `returned`.



234
235
236
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 234

def status
  @status
end

#status_details ⇒ Object (readonly)

Status details for an OutboundPayment in a ‘failed` or `returned` state.



236
237
238
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 236

def status_details
  @status_details
end

#status_transitions ⇒ Object (readonly)

Hash containing timestamps of when the object transitioned to a particular status.



238
239
240
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 238

def status_transitions
  @status_transitions
end

#to ⇒ Object (readonly)

To which payout method the OutboundPayment was sent.



240
241
242
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 240

def to
  @to
end

#trace_id ⇒ Object (readonly)

A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar.



242
243
244
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 242

def trace_id
  @trace_id
end

Class Method Details

.field_remappings ⇒ Object 



259
260
261
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 259

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/stripe/resources/v2/money_management/outbound_payment.rb', line 246

def self.inner_class_types
  @inner_class_types = {
    amount: Amount,
    delivery_options: DeliveryOptions,
    from: From,
    recipient_notification: RecipientNotification,
    status_details: StatusDetails,
    status_transitions: StatusTransitions,
    to: To,
    trace_id: TraceId,
  }
end

.object_name ⇒ Object 



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

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