Class: Stripe::Treasury::InboundTransfer

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Defined in:
lib/stripe/resources/treasury/inbound_transfer.rb

Overview

Use [InboundTransfers](docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.

Related guide: [Moving money with Treasury using InboundTransfer objects](docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)

Defined Under Namespace

Classes: CancelParams, CreateParams, FailParams, FailureDetails, LinkedFlows, ListParams, OriginPaymentMethodDetails, RetrieveParams, ReturnInboundTransferParams, StatusTransitions, SucceedParams, TestHelpers

Constant Summary collapse

OBJECT_NAME = 
"treasury.inbound_transfer"

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::Create

create

Methods included from APIOperations::List

list

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

#==, #[], #[]=, 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)

Amount (in cents) transferred.



213
214
215
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 213

def amount
  @amount
end

#cancelable ⇒ Object (readonly)

Returns ‘true` if the InboundTransfer is able to be canceled.



215
216
217
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 215

def cancelable
  @cancelable
end

#created ⇒ Object (readonly)

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



217
218
219
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 217

def created
  @created
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



219
220
221
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 219

def currency
  @currency
end

#description ⇒ Object (readonly)

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



221
222
223
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 221

def description
  @description
end

#failure_details ⇒ Object (readonly)

Details about this InboundTransfer’s failure. Only set when status is ‘failed`.



223
224
225
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 223

def failure_details
  @failure_details
end

#financial_account ⇒ Object (readonly)

The FinancialAccount that received the funds.



225
226
227
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 225

def 
  @financial_account
end

#hosted_regulatory_receipt_url ⇒ Object (readonly)

A [hosted transaction receipt](stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.



227
228
229
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 227

def hosted_regulatory_receipt_url
  @hosted_regulatory_receipt_url
end

#id ⇒ Object (readonly)

Unique identifier for the object.



229
230
231
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 229

def id
  @id
end

#linked_flows ⇒ Object (readonly)

Attribute for field linked_flows



231
232
233
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 231

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



233
234
235
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 233

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



235
236
237
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 235

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



237
238
239
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 237

def object
  @object
end

#origin_payment_method ⇒ Object (readonly)

The origin payment method to be debited for an InboundTransfer.



239
240
241
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 239

def origin_payment_method
  @origin_payment_method
end

#origin_payment_method_details ⇒ Object (readonly)

Details about the PaymentMethod for an InboundTransfer.



241
242
243
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 241

def origin_payment_method_details
  @origin_payment_method_details
end

#returned ⇒ Object (readonly)

Returns ‘true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.



243
244
245
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 243

def returned
  @returned
end

#statement_descriptor ⇒ Object (readonly)

Statement descriptor shown when funds are debited from the source. Not all payment networks support ‘statement_descriptor`.



245
246
247
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 245

def statement_descriptor
  @statement_descriptor
end

#status ⇒ Object (readonly)

Status of the InboundTransfer: ‘processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been “confirmed” and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.



247
248
249
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 247

def status
  @status
end

#status_transitions ⇒ Object (readonly)

Attribute for field status_transitions



249
250
251
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 249

def status_transitions
  @status_transitions
end

#transaction ⇒ Object (readonly)

The Transaction associated with this object.



251
252
253
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 251

def transaction
  @transaction
end

Class Method Details

.cancel(inbound_transfer, params = {}, opts = {}) ⇒ Object

Cancels an InboundTransfer.



264
265
266
267
268
269
270
271
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 264

def self.cancel(inbound_transfer, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/treasury/inbound_transfers/%<inbound_transfer>s/cancel", { inbound_transfer: CGI.escape(inbound_transfer) }),
    params: params,
    opts: opts
  )
end

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

Creates an InboundTransfer.



274
275
276
277
278
279
280
281
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 274

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/treasury/inbound_transfers",
    params: params,
    opts: opts
  )
end

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

Returns a list of InboundTransfers sent from the specified FinancialAccount.



284
285
286
287
288
289
290
291
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 284

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

.object_name ⇒ Object 



14
15
16
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 14

def self.object_name
  "treasury.inbound_transfer"
end

Instance Method Details

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

Cancels an InboundTransfer.



254
255
256
257
258
259
260
261
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 254

def cancel(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/treasury/inbound_transfers/%<inbound_transfer>s/cancel", { inbound_transfer: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#test_helpers ⇒ Object 



293
294
295
 
# File 'lib/stripe/resources/treasury/inbound_transfer.rb', line 293

def test_helpers
  TestHelpers.new(self)
end