Class: CheckoutSdk::Payments::PaymentSessionsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/checkout_sdk/payments/sessions/payment_sessions_request.rb

Instance Attribute Summary collapse

Instance Attribute Details

#amount ⇒ Integer

Returns:

  • (Integer) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#amount_allocations ⇒ Array(CheckoutSdk::Common::AmountAllocations)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#authorization_type ⇒ String

Returns [Optional] AuthorizationType Enum: “Final” “Estimated”. Default: “Final”.

Returns:

  • (String) —
    Optional

    AuthorizationType Enum: “Final” “Estimated”. Default: “Final”.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#billing ⇒ BillingInformation

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#billing_descriptor ⇒ BillingDescriptor

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#capture ⇒ TrueClass, FalseClass

Returns:

  • (TrueClass, FalseClass) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#capture_on ⇒ Time

Returns:

  • (Time) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#currency ⇒ String

Returns Common::Currency.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#customer ⇒ CheckoutSdk::Common::CustomerRequest

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#description ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#disabled_payment_methods ⇒ Array(PaymentMethodsType)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#display_name ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#enabled_payment_methods ⇒ Array(PaymentMethodsType)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#expires_on ⇒ Time

Returns:

  • (Time) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#failure_url ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#ip_address ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#items ⇒ Array(Product)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#locale ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#metadata ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#payment_method_configuration ⇒ PaymentMethodConfiguration

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#payment_plan ⇒ PaymentPlan

Returns [Optional] The information to process a recurring payment request. To be used when the payment_type is Recurring.

Returns:

  • (PaymentPlan) —
    Optional

    The information to process a recurring payment request.

    To be used when the payment_type is Recurring.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#payment_type ⇒ TrueClass, FalseClass

Returns:

  • (TrueClass, FalseClass) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#processing ⇒ ProcessingSettings

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#processing_channel_id ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#recipient ⇒ PaymentRecipient

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#reference ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#retry ⇒ PaymentRetryRequest

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#risk ⇒ RiskRequest

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#sender ⇒ Sender

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#shipping ⇒ ShippingDetails

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#success_url ⇒ String

Returns:

  • (String) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#tax_amount ⇒ Integer

Returns:

  • (Integer) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end

#three_ds ⇒ ThreeDSRequest

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/checkout_sdk/payments/sessions/payment_sessions_request.rb', line 72

class PaymentSessionsRequest
  attr_accessor :amount,
                :currency,
                :payment_type,
                :billing,
                :billing_descriptor,
                :reference,
                :description,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :processing_channel_id,
                :expires_on,
                :payment_method_configuration,
                :enabled_payment_methods,
                :disabled_payment_methods,
                :items,
                :amount_allocations,
                :risk,
                :retry,
                :display_name,
                :success_url,
                :failure_url,
                :metadata,
                :locale,
                :three_ds,
                :sender,
                :capture,
                :ip_address,
                :capture_on,
                :tax_amount,
                :authorization_type,
                :payment_plan
end