Class: Stripe::Transfer

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List, APIOperations::NestedResource
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/transfer.rb

Overview

A ‘Transfer` object is created when you move funds between Stripe accounts as part of Connect.

Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a [Payout](stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more information, read about the [transfer/payout split](stripe.com/docs/transfer-payout-split).

Related guide: [Creating separate charges and transfers](stripe.com/docs/connect/separate-charges-and-transfers)

Defined Under Namespace

Classes: CreateParams, ListParams, RetrieveParams, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"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

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::NestedResource

nested_resource_class_methods

Methods included from APIOperations::Save

included, #save

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 (or local equivalent) to be transferred.



147
148
149
 
# File 'lib/stripe/resources/transfer.rb', line 147

def amount
  @amount
end

#amount_reversed ⇒ Object (readonly)

Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).



149
150
151
 
# File 'lib/stripe/resources/transfer.rb', line 149

def amount_reversed
  @amount_reversed
end

#balance_transaction ⇒ Object (readonly)

Balance transaction that describes the impact of this transfer on your account balance.



151
152
153
 
# File 'lib/stripe/resources/transfer.rb', line 151

def balance_transaction
  @balance_transaction
end

#created ⇒ Object (readonly)

Time that this record of the transfer was first created.



153
154
155
 
# File 'lib/stripe/resources/transfer.rb', line 153

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



155
156
157
 
# File 'lib/stripe/resources/transfer.rb', line 155

def currency
  @currency
end

#description ⇒ Object (readonly)

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



157
158
159
 
# File 'lib/stripe/resources/transfer.rb', line 157

def description
  @description
end

#destination ⇒ Object (readonly)

ID of the Stripe account the transfer was sent to.



159
160
161
 
# File 'lib/stripe/resources/transfer.rb', line 159

def destination
  @destination
end

#destination_payment ⇒ Object (readonly)

If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.



161
162
163
 
# File 'lib/stripe/resources/transfer.rb', line 161

def destination_payment
  @destination_payment
end

#id ⇒ Object (readonly)

Unique identifier for the object.



163
164
165
 
# File 'lib/stripe/resources/transfer.rb', line 163

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.



165
166
167
 
# File 'lib/stripe/resources/transfer.rb', line 165

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.



167
168
169
 
# File 'lib/stripe/resources/transfer.rb', line 167

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



169
170
171
 
# File 'lib/stripe/resources/transfer.rb', line 169

def object
  @object
end

#reversals ⇒ Object (readonly)

A list of reversals that have been applied to the transfer.



171
172
173
 
# File 'lib/stripe/resources/transfer.rb', line 171

def reversals
  @reversals
end

#reversed ⇒ Object (readonly)

Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.



173
174
175
 
# File 'lib/stripe/resources/transfer.rb', line 173

def reversed
  @reversed
end

#source_transaction ⇒ Object (readonly)

ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.



175
176
177
 
# File 'lib/stripe/resources/transfer.rb', line 175

def source_transaction
  @source_transaction
end

#source_type ⇒ Object (readonly)

The source balance this transfer came from. One of ‘card`, `fpx`, or `bank_account`.



177
178
179
 
# File 'lib/stripe/resources/transfer.rb', line 177

def source_type
  @source_type
end

#transfer_group ⇒ Object (readonly)

A string that identifies this transaction as part of a group. See the [Connect documentation](stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.



179
180
181
 
# File 'lib/stripe/resources/transfer.rb', line 179

def transfer_group
  @transfer_group
end

Class Method Details

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

To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](stripe.com/docs/api#balance) must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.



182
183
184
 
# File 'lib/stripe/resources/transfer.rb', line 182

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

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

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.



187
188
189
 
# File 'lib/stripe/resources/transfer.rb', line 187

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

.object_name ⇒ Object 



22
23
24
 
# File 'lib/stripe/resources/transfer.rb', line 22

def self.object_name
  "transfer"
end

.update(transfer, params = {}, opts = {}) ⇒ Object

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only metadata as an argument.



194
195
196
197
198
199
200
201
 
# File 'lib/stripe/resources/transfer.rb', line 194

def self.update(transfer, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/transfers/%<transfer>s", { transfer: CGI.escape(transfer) }),
    params: params,
    opts: opts
  )
end