Class: CyberSource::Ptsv2creditsProcessingInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2creditsProcessingInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 115

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?(:'commerceIndicator')
    self.commerce_indicator = attributes[:'commerceIndicator']
  end

  if attributes.has_key?(:'processorId')
    self.processor_id = attributes[:'processorId']
  end

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

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

  if attributes.has_key?(:'linkId')
    self.link_id = attributes[:'linkId']
  end

  if attributes.has_key?(:'reportGroup')
    self.report_group = attributes[:'reportGroup']
  end

  if attributes.has_key?(:'visaCheckoutId')
    self.visa_checkout_id = attributes[:'visaCheckoutId']
  end

  if attributes.has_key?(:'purchaseLevel')
    self.purchase_level = attributes[:'purchaseLevel']
  end

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

  if attributes.has_key?(:'walletType')
    self.wallet_type = attributes[:'walletType']
  end

  if attributes.has_key?(:'nationalNetDomesticData')
    self.national_net_domestic_data = attributes[:'nationalNetDomesticData']
  end

  if attributes.has_key?(:'networkRoutingOrder')
    self.network_routing_order = attributes[:'networkRoutingOrder']
  end

  if attributes.has_key?(:'recurringOptions')
    self.recurring_options = attributes[:'recurringOptions']
  end

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

  if attributes.has_key?(:'purchaseOptions')
    self.purchase_options = attributes[:'purchaseOptions']
  end

  if attributes.has_key?(:'electronicBenefitsTransfer')
    self.electronic_benefits_transfer = attributes[:'electronicBenefitsTransfer']
  end

  if attributes.has_key?(:'loanOptions')
    self.loan_options = attributes[:'loanOptions']
  end

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

Instance Attribute Details

#bank_transfer_optionsObject

Returns the value of attribute bank_transfer_options.



55
56
57
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 55

def bank_transfer_options
  @bank_transfer_options
end

#commerce_indicatorObject

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. See Appendix I, "Commerce Indicators," on page 441 of the Cybersource Credit Card Guide. #### 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 (listed in Appendix I, "Commerce Indicators," on page 441.) #### Payer Authentication Transactions For the possible values and requirements, see "Payer Authentication," page 195. #### 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"



18
19
20
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 18

def commerce_indicator
  @commerce_indicator
end

#electronic_benefits_transferObject

Returns the value of attribute electronic_benefits_transfer.



59
60
61
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 59

def electronic_benefits_transfer
  @electronic_benefits_transfer
end

#industry_data_typeObject

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.



42
43
44
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 42

def industry_data_type
  @industry_data_type
end

#japan_payment_optionsObject

Returns the value of attribute japan_payment_options.



63
64
65
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 63

def japan_payment_options
  @japan_payment_options
end

Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments For details, see ‘link_to_request` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



30
31
32
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 30

def link_id
  @link_id
end

#loan_optionsObject

Returns the value of attribute loan_options.



61
62
63
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 61

def loan_options
  @loan_options
end

#national_net_domestic_dataObject

Supplementary domestic transaction information provided by the acquirer for National Net Settlement Service (NNSS) transactions. NNSS is a settlement service that Visa provides. For transactions on CyberSource through VisaNet in countries that subscribe to NNSS: VisaNet clears transactions; VisaNet transfers funds to the acquirer after deducting processing fees and interchange fees. VisaNet settles transactions in the local pricing currency through a local financial institution. This field is supported only on CyberSource through VisaNet for domestic data in Colombia



48
49
50
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 48

def national_net_domestic_data
  @national_net_domestic_data
end

#network_routing_orderObject

On PIN Debit Gateways: This U.S.-only field is optionally used by participants (merchants and acquirers) to specify the network access priority. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the sharing group code. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer’s preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer’s routing priorities. #### PIN debit Priority order of the networks through which he transaction will be routed. Set this value to a series of one-character network codes in your preferred order. This is a list of the network codes: | Network | Code | | — | — | | Accel | E | | AFFN | U | | Alaska Option | 3 | | CU24 | C | | Interlink | G | | Maestro | 8 | | NETS | P | | NYCE | F | | Pulse | H | | Shazam | 7 | | Star | M | | Visa | V | For example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of ‘MH`. When you do not include this value in your PIN debit request, the list of network codes from your account is used. Note This field is supported only for businesses located in the U.S. Optional field for PIN debit credit or PIN debit purchase.



51
52
53
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 51

def network_routing_order
  @network_routing_order
end

#payment_solutionObject

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 SCMP API.](apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see "Masterpass" in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `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.



24
25
26
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 24

def payment_solution
  @payment_solution
end

#processor_idObject

Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field.



21
22
23
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 21

def processor_id
  @processor_id
end

#purchase_levelObject

Set this field to 3 to indicate that the request includes Level III data.



39
40
41
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 39

def purchase_level
  @purchase_level
end

#purchase_optionsObject

Returns the value of attribute purchase_options.



57
58
59
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 57

def purchase_options
  @purchase_options
end

#reconciliation_idObject

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).



27
28
29
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 27

def reconciliation_id
  @reconciliation_id
end

#recurring_optionsObject

Returns the value of attribute recurring_options.



53
54
55
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 53

def recurring_options
  @recurring_options
end

#report_groupObject

Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see ‘report_group` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



33
34
35
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 33

def report_group
  @report_group
end

#visa_checkout_idObject

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



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

def visa_checkout_id
  @visa_checkout_id
end

#wallet_typeObject

This field carries the wallet type in authorization requests and credit requests. Possible value are: - ‘101`: Masterpass remote payment. The customer created the wallet by manually interacting with a customer-controlled device such as a computer, tablet, or phone. This value is supported only for Masterpass transactions on Chase Paymentech Solutions and CyberSource through VisaNet. - `102`: Masterpass remote near field communication (NFC) payment. The customer created the wallet by tapping a PayPass card or customer-controlled device at a contactless card reader. This value is supported only for card-present Masterpass transactions on CyberSource through VisaNet. - `103`: Masterpass Apple Pay payment. The payment was made with a combination of Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay transactions on CyberSource through VisaNet. - `216`: Masterpass Google Pay payment. The payment was made with a combination of Masterpass and Google Pay. This value is supported only for Masterpass Google Pay transactions on CyberSource through VisaNet. - `217`: Masterpass Samsung Pay payment. The payment was made with a combination of Masterpass and Samsung Pay. This value is supported only for Masterpass Samsung Pay transactions on CyberSource through VisaNet. - `SDW`: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions. - `VCIND`: Visa Checkout payment. This value is supported only on CyberSource through VisaNet, FDC Compass, FDC Nashville Global, FDI Australia, and TSYS Acquiring Solutions. See Getting Started with Visa Checkout. For Visa Checkout transactions, the way CyberSource processes the value for this field depends on the processor. See the Visa Checkout section below. For all other values, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor. Masterpass (101, 102, 103, 216, and 217): The Masterpass platform generates the wallet type value and passes it to you along with the customer’s checkout information. Visa Checkout: This field is optional for Visa Checkout authorizations on FDI Australia. For all other processors, this field is required for Visa Checkout authorizations. For Visa Checkout transactions on the following processors, CyberSource sends the value that the processor expects for this field:FDC Compass,FDC Nashville Global,FDI Australia,TSYS Acquiring Solutions For all other processors, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor. For incremental authorizations, this field is supported only for Mastercard and the supported values are 101 and 102. Payment card companies can introduce new values without notice. Your order management system should be able to process new values without problems. CyberSource through VisaNet When the value for this field is 101, 102, 103, 216, or 217, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR6, Position: 88-90, Field: Mastercard Wallet Identifier. When the value for this field is VCIND, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR8, Position: 72-76, Field: Agent Unique ID.



45
46
47
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 45

def wallet_type
  @wallet_type
end

Class Method Details

.attribute_mapObject

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 66

def self.attribute_map
  {
    :'commerce_indicator' => :'commerceIndicator',
    :'processor_id' => :'processorId',
    :'payment_solution' => :'paymentSolution',
    :'reconciliation_id' => :'reconciliationId',
    :'link_id' => :'linkId',
    :'report_group' => :'reportGroup',
    :'visa_checkout_id' => :'visaCheckoutId',
    :'purchase_level' => :'purchaseLevel',
    :'industry_data_type' => :'industryDataType',
    :'wallet_type' => :'walletType',
    :'national_net_domestic_data' => :'nationalNetDomesticData',
    :'network_routing_order' => :'networkRoutingOrder',
    :'recurring_options' => :'recurringOptions',
    :'bank_transfer_options' => :'bankTransferOptions',
    :'purchase_options' => :'purchaseOptions',
    :'electronic_benefits_transfer' => :'electronicBenefitsTransfer',
    :'loan_options' => :'loanOptions',
    :'japan_payment_options' => :'japanPaymentOptions'
  }
end

.swagger_typesObject

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 90

def self.swagger_types
  {
    :'commerce_indicator' => :'String',
    :'processor_id' => :'String',
    :'payment_solution' => :'String',
    :'reconciliation_id' => :'String',
    :'link_id' => :'String',
    :'report_group' => :'String',
    :'visa_checkout_id' => :'String',
    :'purchase_level' => :'String',
    :'industry_data_type' => :'String',
    :'wallet_type' => :'String',
    :'national_net_domestic_data' => :'String',
    :'network_routing_order' => :'String',
    :'recurring_options' => :'Ptsv2paymentsidrefundsProcessingInformationRecurringOptions',
    :'bank_transfer_options' => :'Ptsv2creditsProcessingInformationBankTransferOptions',
    :'purchase_options' => :'Ptsv2creditsProcessingInformationPurchaseOptions',
    :'electronic_benefits_transfer' => :'Ptsv2creditsProcessingInformationElectronicBenefitsTransfer',
    :'loan_options' => :'Ptsv2paymentsProcessingInformationLoanOptions',
    :'japan_payment_options' => :'Ptsv2creditsProcessingInformationJapanPaymentOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commerce_indicator == o.commerce_indicator &&
      processor_id == o.processor_id &&
      payment_solution == o.payment_solution &&
      reconciliation_id == o.reconciliation_id &&
      link_id == o.link_id &&
      report_group == o.report_group &&
      visa_checkout_id == o.visa_checkout_id &&
      purchase_level == o.purchase_level &&
      industry_data_type == o.industry_data_type &&
      wallet_type == o.wallet_type &&
      national_net_domestic_data == o.national_net_domestic_data &&
      network_routing_order == o.network_routing_order &&
      recurring_options == o.recurring_options &&
      bank_transfer_options == o.bank_transfer_options &&
      purchase_options == o.purchase_options &&
      electronic_benefits_transfer == o.electronic_benefits_transfer &&
      loan_options == o.loan_options &&
      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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 340

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



406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 406

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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 319

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("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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


306
307
308
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 306

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



312
313
314
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 312

def hash
  [commerce_indicator, processor_id, payment_solution, reconciliation_id, link_id, report_group, visa_checkout_id, purchase_level, industry_data_type, wallet_type, national_net_domestic_data, network_routing_order, recurring_options, bank_transfer_options, purchase_options, electronic_benefits_transfer, loan_options, japan_payment_options].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



196
197
198
199
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 196

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



386
387
388
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 386

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



392
393
394
395
396
397
398
399
400
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 392

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



380
381
382
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 380

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



203
204
205
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb', line 203

def valid?
  true
end