Class: Stripe::Payout::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/payout.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, metadata: nil, method: nil, payout_method: nil, source_type: nil, statement_descriptor: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/stripe/resources/payout.rb', line 134

def initialize(
  amount: nil,
  currency: nil,
  description: nil,
  destination: nil,
  expand: nil,
  metadata: nil,
  method: nil,
  payout_method: nil,
  source_type: nil,
  statement_descriptor: nil
)
  @amount = amount
  @currency = currency
  @description = description
  @destination = destination
  @expand = expand
  @metadata = metadata
  @method = method
  @payout_method = payout_method
  @source_type = source_type
  @statement_descriptor = statement_descriptor
end

Instance Attribute Details

#amount ⇒ Object

A positive integer in cents representing how much to payout.



114
115
116
 
# File 'lib/stripe/resources/payout.rb', line 114

def amount
  @amount
end

#currency ⇒ Object

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



116
117
118
 
# File 'lib/stripe/resources/payout.rb', line 116

def currency
  @currency
end

#description ⇒ Object

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



118
119
120
 
# File 'lib/stripe/resources/payout.rb', line 118

def description
  @description
end

#destination ⇒ Object

The ID of a bank account or a card to send the payout to. If you don’t provide a destination, we use the default external account for the specified currency.



120
121
122
 
# File 'lib/stripe/resources/payout.rb', line 120

def destination
  @destination
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



122
123
124
 
# File 'lib/stripe/resources/payout.rb', line 122

def expand
  @expand
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`.



124
125
126
 
# File 'lib/stripe/resources/payout.rb', line 124

def metadata
  @metadata
end

#method ⇒ Object

The method used to send this payout, which is ‘standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](stripe.com/docs/payouts/instant-payouts-banks).



126
127
128
 
# File 'lib/stripe/resources/payout.rb', line 126

def method
  @method
end

#payout_method ⇒ Object

The ID of a v2 FinancialAccount to send funds to.



128
129
130
 
# File 'lib/stripe/resources/payout.rb', line 128

def payout_method
  @payout_method
end

#source_type ⇒ Object

The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of ‘bank_account`, `card`, or `fpx`.



130
131
132
 
# File 'lib/stripe/resources/payout.rb', line 130

def source_type
  @source_type
end

#statement_descriptor ⇒ Object

A string that displays on the recipient’s bank or card statement (up to 22 characters). A ‘statement_descriptor` that’s longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.



132
133
134
 
# File 'lib/stripe/resources/payout.rb', line 132

def statement_descriptor
  @statement_descriptor
end