Class: Stripe::PayoutCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/payout_create_params.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) ⇒ PayoutCreateParams

Returns a new instance of PayoutCreateParams.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/stripe/params/payout_create_params.rb', line 27

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.



7
8
9
 
# File 'lib/stripe/params/payout_create_params.rb', line 7

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



9
10
11
 
# File 'lib/stripe/params/payout_create_params.rb', line 9

def currency
  @currency
end

#description ⇒ Object

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



11
12
13
 
# File 'lib/stripe/params/payout_create_params.rb', line 11

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.



13
14
15
 
# File 'lib/stripe/params/payout_create_params.rb', line 13

def destination
  @destination
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



15
16
17
 
# File 'lib/stripe/params/payout_create_params.rb', line 15

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



17
18
19
 
# File 'lib/stripe/params/payout_create_params.rb', line 17

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



19
20
21
 
# File 'lib/stripe/params/payout_create_params.rb', line 19

def method
  @method
end

#payout_method ⇒ Object

The ID of a v2 FinancialAccount to send funds to.



21
22
23
 
# File 'lib/stripe/params/payout_create_params.rb', line 21

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



23
24
25
 
# File 'lib/stripe/params/payout_create_params.rb', line 23

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.



25
26
27
 
# File 'lib/stripe/params/payout_create_params.rb', line 25

def statement_descriptor
  @statement_descriptor
end