Class: Stripe::Treasury::OutboundPaymentListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/treasury/outbound_payment_list_params.rb

Defined Under Namespace

Classes: Created

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, customer: nil, ending_before: nil, expand: nil, financial_account: nil, limit: nil, starting_after: nil, status: nil) ⇒ OutboundPaymentListParams

Returns a new instance of OutboundPaymentListParams.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 41

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

Instance Attribute Details

#created ⇒ Object

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



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

def created
  @created
end

#customer ⇒ Object

Only return OutboundPayments sent to this customer.



27
28
29
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 27

def customer
  @customer
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.



29
30
31
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 29

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



31
32
33
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 31

def expand
  @expand
end

#financial_account ⇒ Object

Returns objects associated with this FinancialAccount.



33
34
35
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 33

def 
  @financial_account
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.



35
36
37
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 35

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.



37
38
39
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 37

def starting_after
  @starting_after
end

#status ⇒ Object

Only return OutboundPayments that have the given status: ‘processing`, `failed`, `posted`, `returned`, or `canceled`.



39
40
41
 
# File 'lib/stripe/params/treasury/outbound_payment_list_params.rb', line 39

def status
  @status
end