Class: CheckoutSdk::Payments::HostedPaymentsSession

Inherits:
Object
  • Object
show all
Defined in:
lib/checkout_sdk/payments/hosted/hosted_payments_session.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR) ⇒ HostedPaymentsSession

Returns a new instance of HostedPaymentsSession.



102
103
104
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 102

def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
  @payment_type = payment_type
end

Instance Attribute Details

#allow_payment_methodsArray(CheckoutSdk::Common::PaymentSourceType)



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#amountInteger

Returns:

  • (Integer)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#amount_allocationsArray(CheckoutSdk::Common::AmountAllocations)



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#billingBillingInformation

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#billing_descriptorBillingDescriptor

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#cancel_urlString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#captureTrueClass, FalseClass

Returns:

  • (TrueClass, FalseClass)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#capture_onTime

Returns:

  • (Time)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#currencyString

Returns Common::Currency.

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#customerCheckoutSdk::Common::CustomerRequest



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#customer_retryPaymentRetryRequest

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#descriptionString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#disabled_payment_methodsArray(CheckoutSdk::Common::PaymentSourceType)



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#display_nameString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#failure_urlString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#instructionHostedPaymentInstruction



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#localeString

Returns LocaleType.

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#metadataHash(String=>Object)

Returns:

  • (Hash(String=>Object))


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#payment_ipString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#payment_method_configurationPaymentMethodConfiguration



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#payment_typeString

Returns PaymentType.

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#processingProcessingSettings

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#processing_channel_idString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#productsArray(CheckoutSdk::Common::Product)

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#recipientPaymentRecipient

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#referenceString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#riskRiskRequest

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#senderCheckoutSdk::Payments::Sender



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#shippingShippingDetails

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#success_urlString

Returns:

  • (String)


69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end

#three_dsThreeDSRequest

Returns:



69
70
71
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
# File 'lib/checkout_sdk/payments/hosted/hosted_payments_session.rb', line 69

class HostedPaymentsSession
  attr_accessor :currency,
                :billing,
                :success_url,
                :cancel_url,
                :failure_url,
                :amount,
                :payment_type,
                :payment_ip,
                :billing_descriptor,
                :reference,
                :description,
                :display_name,
                :processing_channel_id,
                :amount_allocations,
                :customer,
                :shipping,
                :recipient,
                :processing,
                :allow_payment_methods,
                :disabled_payment_methods,
                :products,
                :risk,
                :customer_retry,
                :sender,
                :metadata,
                :locale,
                :three_ds,
                :capture,
                :capture_on,
                :instruction,
                :payment_method_configuration

  def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
    @payment_type = payment_type
  end
end