Class: Stripe::Payout::ListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/payout.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) ⇒ ListParams

Returns a new instance of ListParams.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/stripe/resources/payout.rb', line 83

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.



67
68
69
 
# File 'lib/stripe/resources/payout.rb', line 67

def arrival_date
  @arrival_date
end

#created ⇒ Object

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



69
70
71
 
# File 'lib/stripe/resources/payout.rb', line 69

def created
  @created
end

#destination ⇒ Object

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



71
72
73
 
# File 'lib/stripe/resources/payout.rb', line 71

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.



73
74
75
 
# File 'lib/stripe/resources/payout.rb', line 73

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



75
76
77
 
# File 'lib/stripe/resources/payout.rb', line 75

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.



77
78
79
 
# File 'lib/stripe/resources/payout.rb', line 77

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.



79
80
81
 
# File 'lib/stripe/resources/payout.rb', line 79

def starting_after
  @starting_after
end

#status ⇒ Object

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



81
82
83
 
# File 'lib/stripe/resources/payout.rb', line 81

def status
  @status
end