Class: CyberSource::TssV2TransactionsGet200ResponseProcessingInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TssV2TransactionsGet200ResponseProcessingInformation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 98

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'binSource')
    self.bin_source = attributes[:'binSource']
  end

  if attributes.has_key?(:'industryDataType')
    self.industry_data_type = attributes[:'industryDataType']
  end

  if attributes.has_key?(:'paymentSolution')
    self.payment_solution = attributes[:'paymentSolution']
  end

  if attributes.has_key?(:'commerceIndicator')
    self.commerce_indicator = attributes[:'commerceIndicator']
  end

  if attributes.has_key?(:'commerceIndicatorLabel')
    self.commerce_indicator_label = attributes[:'commerceIndicatorLabel']
  end

  if attributes.has_key?(:'businessApplicationId')
    self.business_application_id = attributes[:'businessApplicationId']
  end

  if attributes.has_key?(:'authorizationOptions')
    self.authorization_options = attributes[:'authorizationOptions']
  end

  if attributes.has_key?(:'bankTransferOptions')
    self.bank_transfer_options = attributes[:'bankTransferOptions']
  end

  if attributes.has_key?(:'captureOptions')
    self.capture_options = attributes[:'captureOptions']
  end

  if attributes.has_key?(:'reconciliationId')
    self.reconciliation_id = attributes[:'reconciliationId']
  end

  if attributes.has_key?(:'japanPaymentOptions')
    self.japan_payment_options = attributes[:'japanPaymentOptions']
  end
end

Instance Attribute Details

#authorization_options ⇒ Object

Returns the value of attribute authorization_options.



34
35
36
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 34

def authorization_options
  @authorization_options
end

#bank_transfer_options ⇒ Object

Returns the value of attribute bank_transfer_options.



36
37
38
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 36

def bank_transfer_options
  @bank_transfer_options
end

#bin_source ⇒ Object

Bin Source File Identifier. Possible values: - itmx - rupay



17
18
19
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 17

def bin_source
  @bin_source
end

#business_application_id ⇒ Object

Required for AFT and OCT transactions. Given below is a list of all the BAI values available. However, the processors may support only few specific BAI values. - AA : Account-to-account - BB : Supplier Payments - BI : Bank-Initiated P2P Money Transfer - BP : Non-Card Bill Pay/Bill Pay - CD : Cash Deposit - CP : Credit card Bill Payment - FD : Funds disbursement - FT : Funds transfer - GD : Government Disbursement - GP : Gambling payout (non-online gambling) - LO : Loyalty credits and rebates - MD : Merchant Settlement - OG : Online Gambling Payout - PD : Payroll and pension disbursement - PP : Person-to-Person or Peer-to-Peer - TU : Top up, prepaid load - WT : Digital wallet



32
33
34
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 32

def business_application_id
  @business_application_id
end

#capture_options ⇒ Object

Returns the value of attribute capture_options.



38
39
40
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 38

def capture_options
  @capture_options
end

#commerce_indicator ⇒ Object

Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by Authorization Required payer authentication transactions; otherwise, optional. Credit Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to ‘retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as "moto"



26
27
28
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 26

def commerce_indicator
  @commerce_indicator
end

#commerce_indicator_label ⇒ Object

Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by Authorization Required payer authentication transactions; otherwise, optional. Credit Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to ‘retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto`



29
30
31
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 29

def commerce_indicator_label
  @commerce_indicator_label
end

#industry_data_type ⇒ Object

Indicates that the transaction includes industry-specific data. Possible Values: - ‘airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet.



20
21
22
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 20

def industry_data_type
  @industry_data_type
end

#japan_payment_options ⇒ Object

Returns the value of attribute japan_payment_options.



43
44
45
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 43

def japan_payment_options
  @japan_payment_options
end

#payment_solution ⇒ Object

Type of digital payment solution for the transaction.



23
24
25
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 23

def payment_solution
  @payment_solution
end

#reconciliation_id ⇒ Object

Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response.



41
42
43
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 41

def reconciliation_id
  @reconciliation_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 46

def self.attribute_map
  {
    :'bin_source' => :'binSource',
    :'industry_data_type' => :'industryDataType',
    :'payment_solution' => :'paymentSolution',
    :'commerce_indicator' => :'commerceIndicator',
    :'commerce_indicator_label' => :'commerceIndicatorLabel',
    :'business_application_id' => :'businessApplicationId',
    :'authorization_options' => :'authorizationOptions',
    :'bank_transfer_options' => :'bankTransferOptions',
    :'capture_options' => :'captureOptions',
    :'reconciliation_id' => :'reconciliationId',
    :'japan_payment_options' => :'japanPaymentOptions'
  }
end

.json_map ⇒ Object

Attribute mapping from JSON key to ruby-style variable name.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 63

def self.json_map
  {
    :'bin_source' => :'bin_source',
    :'industry_data_type' => :'industry_data_type',
    :'payment_solution' => :'payment_solution',
    :'commerce_indicator' => :'commerce_indicator',
    :'commerce_indicator_label' => :'commerce_indicator_label',
    :'business_application_id' => :'business_application_id',
    :'authorization_options' => :'authorization_options',
    :'bank_transfer_options' => :'bank_transfer_options',
    :'capture_options' => :'capture_options',
    :'reconciliation_id' => :'reconciliation_id',
    :'japan_payment_options' => :'japan_payment_options'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 80

def self.swagger_types
  {
    :'bin_source' => :'String',
    :'industry_data_type' => :'String',
    :'payment_solution' => :'String',
    :'commerce_indicator' => :'String',
    :'commerce_indicator_label' => :'String',
    :'business_application_id' => :'String',
    :'authorization_options' => :'TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions',
    :'bank_transfer_options' => :'TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions',
    :'capture_options' => :'TssV2TransactionsGet200ResponseProcessingInformationCaptureOptions',
    :'reconciliation_id' => :'String',
    :'japan_payment_options' => :'TssV2TransactionsGet200ResponseProcessingInformationJapanPaymentOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bin_source == o.bin_source &&
      industry_data_type == o.industry_data_type &&
      payment_solution == o.payment_solution &&
      commerce_indicator == o.commerce_indicator &&
      commerce_indicator_label == o.commerce_indicator_label &&
      business_application_id == o.business_application_id &&
      authorization_options == o.authorization_options &&
      bank_transfer_options == o.bank_transfer_options &&
      capture_options == o.capture_options &&
      reconciliation_id == o.reconciliation_id &&
      japan_payment_options == o.japan_payment_options
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 246

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 312

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 225

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


212
213
214
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



218
219
220
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 218

def hash
  [bin_source, industry_data_type, payment_solution, commerce_indicator, commerce_indicator_label, business_application_id, authorization_options, bank_transfer_options, capture_options, reconciliation_id, japan_payment_options].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



151
152
153
154
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 151

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



292
293
294
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 292

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 298

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



286
287
288
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 286

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



158
159
160
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb', line 158

def valid?
  true
end