Class: Stripe::V2::Payments::OffSessionPaymentService::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/v2/payments/off_session_payment_service.rb

Defined Under Namespace

Classes: RetryDetails, TransferData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, cadence: nil, customer: nil, metadata: nil, on_behalf_of: nil, payment_method: nil, retry_details: nil, statement_descriptor: nil, statement_descriptor_suffix: nil, test_clock: nil, transfer_data: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 54

def initialize(
  amount: nil,
  cadence: nil,
  customer: nil,
  metadata: nil,
  on_behalf_of: nil,
  payment_method: nil,
  retry_details: nil,
  statement_descriptor: nil,
  statement_descriptor_suffix: nil,
  test_clock: nil,
  transfer_data: nil
)
  @amount = amount
  @cadence = cadence
  @customer = customer
  @metadata = metadata
  @on_behalf_of = on_behalf_of
  @payment_method = payment_method
  @retry_details = retry_details
  @statement_descriptor = statement_descriptor
  @statement_descriptor_suffix = statement_descriptor_suffix
  @test_clock = test_clock
  @transfer_data = transfer_data
end

Instance Attribute Details

#amount ⇒ Object

Amount you want to collect.



32
33
34
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 32

def amount
  @amount
end

#cadence ⇒ Object

The frequency of the OSP.



34
35
36
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 34

def cadence
  @cadence
end

#customer ⇒ Object

Customer that owns the provided payment method.



36
37
38
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 36

def customer
  @customer
end

#metadata ⇒ Object

Any of your internal data you want to track here.



38
39
40
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 38

def metadata
  @metadata
end

#on_behalf_of ⇒ Object

The OBO merchant you want to use.



40
41
42
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 40

def on_behalf_of
  @on_behalf_of
end

#payment_method ⇒ Object

Payment method you want to debit. Must be attached to a customer and set up for off-session usage.



42
43
44
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 42

def payment_method
  @payment_method
end

#retry_details ⇒ Object

How you want stripe to retry the OSP.



44
45
46
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 44

def retry_details
  @retry_details
end

#statement_descriptor ⇒ Object

String you want to appear on your customer’s statement.



46
47
48
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 46

def statement_descriptor
  @statement_descriptor
end

#statement_descriptor_suffix ⇒ Object

Suffix appended to your account level descriptor.



48
49
50
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 48

def statement_descriptor_suffix
  @statement_descriptor_suffix
end

#test_clock ⇒ Object

Test clock to be used for testing your retry handling. Only usable in a sandbox.



50
51
52
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 50

def test_clock
  @test_clock
end

#transfer_data ⇒ Object

How you want to transfer the funds to your connected accounts.



52
53
54
 
# File 'lib/stripe/services/v2/payments/off_session_payment_service.rb', line 52

def transfer_data
  @transfer_data
end