Class: CyberSource::Ptsv1pushfundstransferProcessingInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv1pushfundstransferProcessingInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 83

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

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

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

  if attributes.has_key?(:'payoutsOptions')
    self.payouts_options = attributes[:'payoutsOptions']
  end

  if attributes.has_key?(:'purposeOfPayment')
    self.purpose_of_payment = attributes[:'purposeOfPayment']
  end

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

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

  if attributes.has_key?(:'transactionReason')
    self.transaction_reason = attributes[:'transactionReason']
  end
end

Instance Attribute Details

#business_application_id ⇒ Object

Payouts transaction type. Required for Mastercard Send. Valid Values- Visa Platform Connect: - ‘AA`: Account to account. - `CP`: Card bill payment - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. - `TU`: Top-up for enhanced prepaid loads. Mastercard Send: - `BB`: Business to business. - `BD`: Business Disbursement - `CP`: Card bill payment - `GD`: Government disbursement - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `OG`: Online gambling payout. Chase Paymentech Solutions: - `AA`: Account to account. - `FD`: Funds disbursement (general) - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `PP`: Person to person. FDC Compass: - `BB`: Business to business. - `BI`: Bank-initiated money transfer. - `FD`: Funds disbursement (general) - `GD`: Government disbursement - `GP`: Gambling Payment - `LO`: Loyalty Offers - `MD`: Merchant disbursement (acquirers or aggregators settling to merchants). - `MI`: Merchant initated money transfer - `OG`: Online gambling payout. - `PD`: Payroll pension disbursement. - `PP`: Person to person. - `WT`: Wallet transfer.



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

def business_application_id
  @business_application_id
end

#commerce_indicator ⇒ Object

Type of transaction. Value for an OCT transaction: internet For details, see the e_commerce_indicator field description in Payouts Using the SCMP API.



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

def commerce_indicator
  @commerce_indicator
end

#network_routing_order ⇒ Object

Visa Platform Connect This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. 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. For details, see the network_order field description in BIN Lookup Service Using the SCMP API.



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

def network_routing_order
  @network_routing_order
end

#payouts_options ⇒ Object

Returns the value of attribute payouts_options.



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

def payouts_options
  @payouts_options
end

#purpose_of_payment ⇒ Object

This will send purpose of funds code for original credit transactions (OCTs). Visa Platform Connect (VPC) This will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer’s country and vary by country. Mastercard Send: - ‘00`: Family Support - `01`: Regular Labor Transfers (expatriates), - `02`: Travel & Tourism - `03`: Education - `04`: Hospitalization & Medical Treatment, - `05`: Emergency Need - `06`: Savings - `07`: Gifts - `08`: Other - `09`: Salary - `10`: Crowd lending - `11`: Crypto currency - `12`: Refund to original card - `13`: Refund to new card



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

def purpose_of_payment
  @purpose_of_payment
end

#reconciliation_id ⇒ Object

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



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

def reconciliation_id
  @reconciliation_id
end

#recurring_options ⇒ Object

Returns the value of attribute recurring_options.



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

def recurring_options
  @recurring_options
end

#transaction_reason ⇒ Object

Transaction reason code. This field applies only to Visa Platform Connect



37
38
39
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 37

def transaction_reason
  @transaction_reason
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 40

def self.attribute_map
  {
    :'business_application_id' => :'businessApplicationId',
    :'commerce_indicator' => :'commerceIndicator',
    :'network_routing_order' => :'networkRoutingOrder',
    :'payouts_options' => :'payoutsOptions',
    :'purpose_of_payment' => :'purposeOfPayment',
    :'reconciliation_id' => :'reconciliationId',
    :'recurring_options' => :'recurringOptions',
    :'transaction_reason' => :'transactionReason'
  }
end

.json_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 54

def self.json_map
  {
    :'business_application_id' => :'business_application_id',
    :'commerce_indicator' => :'commerce_indicator',
    :'network_routing_order' => :'network_routing_order',
    :'payouts_options' => :'payouts_options',
    :'purpose_of_payment' => :'purpose_of_payment',
    :'reconciliation_id' => :'reconciliation_id',
    :'recurring_options' => :'recurring_options',
    :'transaction_reason' => :'transaction_reason'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 68

def self.swagger_types
  {
    :'business_application_id' => :'String',
    :'commerce_indicator' => :'String',
    :'network_routing_order' => :'String',
    :'payouts_options' => :'Ptsv1pushfundstransferProcessingInformationPayoutsOptions',
    :'purpose_of_payment' => :'String',
    :'reconciliation_id' => :'String',
    :'recurring_options' => :'Ptsv1pushfundstransferProcessingInformationRecurringOptions',
    :'transaction_reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_application_id == o.business_application_id &&
      commerce_indicator == o.commerce_indicator &&
      network_routing_order == o.network_routing_order &&
      payouts_options == o.payouts_options &&
      purpose_of_payment == o.purpose_of_payment &&
      reconciliation_id == o.reconciliation_id &&
      recurring_options == o.recurring_options &&
      transaction_reason == o.transaction_reason
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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 231

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 297

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 210

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [business_application_id, commerce_indicator, network_routing_order, payouts_options, purpose_of_payment, reconciliation_id, recurring_options, transaction_reason].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



124
125
126
127
128
129
130
131
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 124

def list_invalid_properties
  invalid_properties = Array.new
  if @commerce_indicator.nil?
    invalid_properties.push('invalid value for "commerce_indicator", commerce_indicator cannot be nil.')
  end

  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



277
278
279
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 277

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



283
284
285
286
287
288
289
290
291
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 283

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



271
272
273
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 271

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



135
136
137
138
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 135

def valid?
  return false if @commerce_indicator.nil?
  true
end