Class: Stripe::PayoutListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/payout_list_params.rb

Defined Under Namespace

Classes: ArrivalDate, Created

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(arrival_date: nil, created: nil, destination: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, status: nil) ⇒ PayoutListParams

Returns a new instance of PayoutListParams.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/stripe/params/payout_list_params.rb', line 58

def initialize(
  arrival_date: nil,
  created: nil,
  destination: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  starting_after: nil,
  status: nil
)
  @arrival_date = arrival_date
  @created = created
  @destination = destination
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @starting_after = starting_after
  @status = status
end

Instance Attribute Details

#arrival_date ⇒ Object

Only return payouts that are expected to arrive during the given date interval.



42
43
44
 
# File 'lib/stripe/params/payout_list_params.rb', line 42

def arrival_date
  @arrival_date
end

#created ⇒ Object

Only return payouts that were created during the given date interval.



44
45
46
 
# File 'lib/stripe/params/payout_list_params.rb', line 44

def created
  @created
end

#destination ⇒ Object

The ID of an external account - only return payouts sent to this external account.



46
47
48
 
# File 'lib/stripe/params/payout_list_params.rb', line 46

def destination
  @destination
end

#ending_before ⇒ Object

A cursor for use in pagination. ‘ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.



48
49
50
 
# File 'lib/stripe/params/payout_list_params.rb', line 48

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



50
51
52
 
# File 'lib/stripe/params/payout_list_params.rb', line 50

def expand
  @expand
end

#limit ⇒ Object

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.



52
53
54
 
# File 'lib/stripe/params/payout_list_params.rb', line 52

def limit
  @limit
end

#starting_after ⇒ Object

A cursor for use in pagination. ‘starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.



54
55
56
 
# File 'lib/stripe/params/payout_list_params.rb', line 54

def starting_after
  @starting_after
end

#status ⇒ Object

Only return payouts that have the given status: ‘pending`, `paid`, `failed`, or `canceled`.



56
57
58
 
# File 'lib/stripe/params/payout_list_params.rb', line 56

def status
  @status
end