Class: CyberSourceMergedSpec::ProcessingInformation3

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/processing_information3.rb

Overview

ProcessingInformation3 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(payment_solution: SKIP, reconciliation_id: SKIP, link_id: SKIP, report_group: SKIP, visa_checkout_id: SKIP, issuer: SKIP, action_list: SKIP, transaction_type_indicator: SKIP, additional_properties: nil) ⇒ ProcessingInformation3

Returns a new instance of ProcessingInformation3.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 153

def initialize(payment_solution: SKIP, reconciliation_id: SKIP,
               link_id: SKIP, report_group: SKIP, visa_checkout_id: SKIP,
               issuer: SKIP, action_list: SKIP,
               transaction_type_indicator: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @payment_solution = payment_solution unless payment_solution == SKIP
  @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
  @link_id = link_id unless link_id == SKIP
  @report_group = report_group unless report_group == SKIP
  @visa_checkout_id = visa_checkout_id unless visa_checkout_id == SKIP
  @issuer = issuer unless issuer == SKIP
  @action_list = action_list unless action_list == SKIP
  unless transaction_type_indicator == SKIP
    @transaction_type_indicator =
      transaction_type_indicator
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#action_list ⇒ Array[String]

Array of actions (one or more) to be included in the reversal Possible value:

  • AP_AUTH_REVERSAL: Use this when you want to reverse an Alternative Payment Authorization.

Returns:

  • (Array[String]) 


80
81
82
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 80

def action_list
  @action_list
end

#issuer ⇒ Issuer

Identifier for the Visa Checkout order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout callID field.

Returns:



73
74
75
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 73

def issuer
  @issuer
end

#link_id ⇒ String

Value that links the current authorization request to the original authorization request or previous declined Merchant Initiated Debt Recovery Transactions . Set this value to the ID that was returned in the reply message from the original authorization request or previous declined Merchant Initiated Debt Recovery Transactions. This value is used for:

  • Partial authorizations
  • Split shipments
  • Merchant Initiated Debt Recovery Transactions for Visa Platform Connect and China Union Pay merchants

Returns:

  • (String) 


56
57
58
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 56

def link_id
  @link_id
end

#payment_solution ⇒ String

Type of digital payment solution for the transaction. Possible Values:

  • visacheckout: Visa Checkout. This value is required for Visa Checkout transactions. For details, see payment_solution field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifie lds/reference/all/rest/api-fields.pdf)
  • 001: Apple Pay.
  • 004: Cybersource In-App Solution.
  • 005: Masterpass. This value is required for Masterpass transactions on OmniPay Direct.
  • 006: Android Pay.
  • 007: Chase Pay.
  • 008: Samsung Pay.
  • 012: Google Pay.
  • 013: Cybersource P2PE Decryption
  • 014: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.
  • 015: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.
  • 027: Click to Pay.

Returns:

  • (String) 


35
36
37
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 35

def payment_solution
  @payment_solution
end

#reconciliation_id ⇒ String

Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request.

  • For Payouts: max length for FDCCompass is String (22).

Returns:

  • (String) 


42
43
44
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 42

def reconciliation_id
  @reconciliation_id
end

#report_group ⇒ String

Attribute that lets you define custom grouping for your processor reports. This field is supported only for Worldpay VAP.

Returns:

  • (String) 


61
62
63
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 61

def report_group
  @report_group
end

#transaction_type_indicator ⇒ String

This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only. Possible values:

  • 201- Mastercard Rebate
  • 202- rePower Load Value
  • 203- Gaming Re-pay
  • 204- General Person-to-Person
  • 205- General Transfer to Own Account
  • 206- Agent Cash Out
  • 207- Payment of Own Credit Card Bill
  • 208- Business Disbursement
  • 209- Government/Non-Profit Disbursement
  • 210- Rapid Merchant Settlement
  • 211- Cash in at ATM (Usage limited to specific countries)
  • 212- Cash in at Point of Sale (Usage limited to specific countries)
  • 213- General Business to Business Transfer
  • 214- Mastercard Merchant Presented QR
  • 215- Mastercard Merchant Presented QR Refund Payment
  • 216- Utility Payments (for Brazil domestic use only)
  • 217- Government Services (for Brazil domestic use only)
  • 218- Mobile phone top-ups (for Brazil domestic use only)
  • 219- Coupon booklet payments (for Brazil domestic use only)
  • 220- General Person-to-Person Transfer
  • 221- Person-to-Person Transfer to Card Account
  • 222- General Transfer to Own Account
  • 223- Agent Cash Out
  • 224- Payment of Own Credit Card Bill
  • 225- Business Disbursement
  • 226- Transfer to Own Staged Digital Wallet Account
  • 227- Transfer to Own Debit or Prepaid Account
  • 228- General Business-to-Business Transfer
  • 229- Installment-based repayment
  • 230- Mastercard ATM Cash Pick-Up Transaction
  • 231- Cryptocurrency
  • 232- High-risk Securities

Returns:

  • (String) 


118
119
120
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 118

def transaction_type_indicator
  @transaction_type_indicator
end

#visa_checkout_id ⇒ String

Identifier for the Visa Checkout order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout callID field.

Returns:

  • (String) 


67
68
69
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 67

def visa_checkout_id
  @visa_checkout_id
end

Class Method Details

.from_element(root) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 211

def self.from_element(root)
  payment_solution = XmlUtilities.from_element(root, 'paymentSolution',
                                               String)
  reconciliation_id = XmlUtilities.from_element(root, 'reconciliationId',
                                                String)
  link_id = XmlUtilities.from_element(root, 'linkId', String)
  report_group = XmlUtilities.from_element(root, 'reportGroup', String)
  visa_checkout_id = XmlUtilities.from_element(root, 'visaCheckoutId',
                                               String)
  issuer = XmlUtilities.from_element(root, 'Issuer', Issuer)
  action_list = XmlUtilities.from_element_to_array(root, 'actionList',
                                                   String)
  transaction_type_indicator = XmlUtilities.from_element(
    root, 'transactionTypeIndicator', String
  )

  new(payment_solution: payment_solution,
      reconciliation_id: reconciliation_id,
      link_id: link_id,
      report_group: report_group,
      visa_checkout_id: visa_checkout_id,
      issuer: issuer,
      action_list: action_list,
      transaction_type_indicator: transaction_type_indicator,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 175

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  payment_solution =
    hash.key?('paymentSolution') ? hash['paymentSolution'] : SKIP
  reconciliation_id =
    hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
  link_id = hash.key?('linkId') ? hash['linkId'] : SKIP
  report_group = hash.key?('reportGroup') ? hash['reportGroup'] : SKIP
  visa_checkout_id =
    hash.key?('visaCheckoutId') ? hash['visaCheckoutId'] : SKIP
  issuer = Issuer.from_hash(hash['issuer']) if hash['issuer']
  action_list = hash.key?('actionList') ? hash['actionList'] : SKIP
  transaction_type_indicator =
    hash.key?('transactionTypeIndicator') ? hash['transactionTypeIndicator'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ProcessingInformation3.new(payment_solution: payment_solution,
                             reconciliation_id: reconciliation_id,
                             link_id: link_id,
                             report_group: report_group,
                             visa_checkout_id: visa_checkout_id,
                             issuer: issuer,
                             action_list: action_list,
                             transaction_type_indicator: transaction_type_indicator,
                             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 121

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['payment_solution'] = 'paymentSolution'
  @_hash['reconciliation_id'] = 'reconciliationId'
  @_hash['link_id'] = 'linkId'
  @_hash['report_group'] = 'reportGroup'
  @_hash['visa_checkout_id'] = 'visaCheckoutId'
  @_hash['issuer'] = 'issuer'
  @_hash['action_list'] = 'actionList'
  @_hash['transaction_type_indicator'] = 'transactionTypeIndicator'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



149
150
151
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 149

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 135

def self.optionals
  %w[
    payment_solution
    reconciliation_id
    link_id
    report_group
    visa_checkout_id
    issuer
    action_list
    transaction_type_indicator
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



270
271
272
273
274
275
276
277
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 270

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} payment_solution: #{@payment_solution.inspect}, reconciliation_id:"\
  " #{@reconciliation_id.inspect}, link_id: #{@link_id.inspect}, report_group:"\
  " #{@report_group.inspect}, visa_checkout_id: #{@visa_checkout_id.inspect}, issuer:"\
  " #{@issuer.inspect}, action_list: #{@action_list.inspect}, transaction_type_indicator:"\
  " #{@transaction_type_indicator.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



260
261
262
263
264
265
266
267
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 260

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} payment_solution: #{@payment_solution}, reconciliation_id:"\
  " #{@reconciliation_id}, link_id: #{@link_id}, report_group: #{@report_group},"\
  " visa_checkout_id: #{@visa_checkout_id}, issuer: #{@issuer}, action_list: #{@action_list},"\
  " transaction_type_indicator: #{@transaction_type_indicator}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/cyber_source_merged_spec/models/processing_information3.rb', line 238

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_as_subelement(doc, root, 'paymentSolution',
                                 payment_solution)
  XmlUtilities.add_as_subelement(doc, root, 'reconciliationId',
                                 reconciliation_id)
  XmlUtilities.add_as_subelement(doc, root, 'linkId', link_id)
  XmlUtilities.add_as_subelement(doc, root, 'reportGroup', report_group)
  XmlUtilities.add_as_subelement(doc, root, 'visaCheckoutId',
                                 visa_checkout_id)
  XmlUtilities.add_as_subelement(doc, root, 'Issuer', issuer)
  XmlUtilities.add_array_as_subelement(doc, root, 'actionList', action_list)
  XmlUtilities.add_as_subelement(doc, root, 'transactionTypeIndicator',
                                 transaction_type_indicator)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end