Class: Stripe::Transfer::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/transfer.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, currency: nil, description: nil, destination: nil, expand: nil, fx_quote: nil, metadata: nil, source_transaction: nil, source_type: nil, transfer_group: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/stripe/resources/transfer.rb', line 102

def initialize(
  amount: nil,
  currency: nil,
  description: nil,
  destination: nil,
  expand: nil,
  fx_quote: nil,
  metadata: nil,
  source_transaction: nil,
  source_type: nil,
  transfer_group: nil
)
  @amount = amount
  @currency = currency
  @description = description
  @destination = destination
  @expand = expand
  @fx_quote = fx_quote
  @metadata = metadata
  @source_transaction = source_transaction
  @source_type = source_type
  @transfer_group = transfer_group
end

Instance Attribute Details

#amount ⇒ Object

A positive integer in cents (or local equivalent) representing how much to transfer.



82
83
84
 
# File 'lib/stripe/resources/transfer.rb', line 82

def amount
  @amount
end

#currency ⇒ Object

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



84
85
86
 
# File 'lib/stripe/resources/transfer.rb', line 84

def currency
  @currency
end

#description ⇒ Object

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



86
87
88
 
# File 'lib/stripe/resources/transfer.rb', line 86

def description
  @description
end

#destination ⇒ Object

The ID of a connected Stripe account. <a href=“/docs/connect/separate-charges-and-transfers”>See the Connect documentation</a> for details.



88
89
90
 
# File 'lib/stripe/resources/transfer.rb', line 88

def destination
  @destination
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



90
91
92
 
# File 'lib/stripe/resources/transfer.rb', line 90

def expand
  @expand
end

#fx_quote ⇒ Object

The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.



92
93
94
 
# File 'lib/stripe/resources/transfer.rb', line 92

def fx_quote
  @fx_quote
end

#metadata ⇒ Object

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



94
95
96
 
# File 'lib/stripe/resources/transfer.rb', line 94

def metadata
  @metadata
end

#source_transaction ⇒ Object

You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details.



96
97
98
 
# File 'lib/stripe/resources/transfer.rb', line 96

def source_transaction
  @source_transaction
end

#source_type ⇒ Object

The source balance to use for this transfer. One of ‘bank_account`, `card`, or `fpx`. For most users, this will default to `card`.



98
99
100
 
# File 'lib/stripe/resources/transfer.rb', line 98

def source_type
  @source_type
end

#transfer_group ⇒ Object

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.



100
101
102
 
# File 'lib/stripe/resources/transfer.rb', line 100

def transfer_group
  @transfer_group
end