Class: Stripe::BalanceTransactionService::ListParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/balance_transaction_service.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, currency: nil, ending_before: nil, expand: nil, limit: nil, payout: nil, source: nil, starting_after: nil, type: nil) ⇒ ListParams

Returns a new instance of ListParams.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 43

def initialize(
  created: nil,
  currency: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  payout: nil,
  source: nil,
  starting_after: nil,
  type: nil
)
  @created = created
  @currency = currency
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @payout = payout
  @source = source
  @starting_after = starting_after
  @type = type
end

Instance Attribute Details

#created ⇒ Object

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



25
26
27
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 25

def created
  @created
end

#currency ⇒ Object

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



27
28
29
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 27

def currency
  @currency
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/services/balance_transaction_service.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/services/balance_transaction_service.rb', line 31

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.



33
34
35
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 33

def limit
  @limit
end

#payout ⇒ Object

For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.



35
36
37
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 35

def payout
  @payout
end

#source ⇒ Object

Only returns the original transaction.



37
38
39
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 37

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



39
40
41
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 39

def starting_after
  @starting_after
end

#type ⇒ Object

Only returns transactions of the given type. One of: ‘adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.



41
42
43
 
# File 'lib/stripe/services/balance_transaction_service.rb', line 41

def type
  @type
end