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



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
148
149
150
151
152
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 101

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

  if attributes.has_key?(:'feeProgramId')
    self.fee_program_id = attributes[:'feeProgramId']
  end

  if attributes.has_key?(:'networkPartnerId')
    self.network_partner_id = attributes[:'networkPartnerId']
  end

  if attributes.has_key?(:'transactionTypeIndicator')
    self.transaction_type_indicator = attributes[:'transactionTypeIndicator']
  end

  if attributes.has_key?(:'interchangeRateDesignator')
    self.interchange_rate_designator = attributes[:'interchangeRateDesignator']
  end

  if attributes.has_key?(:'processingCode')
    self.processing_code = attributes[:'processingCode']
  end

  if attributes.has_key?(:'sharingGroupCode')
    self.sharing_group_code = attributes[:'sharingGroupCode']
  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?(:'accountVerificationCode')
    if (value = attributes[:'accountVerificationCode']).is_a?(Array)
      self. = value
    end
  end
end

Instance Attribute Details

#account_verification_code ⇒ Object

Account verification code will inform what Payment Account Verification should be performed. With this array of codes, a merchant can choose à la carte what verifications to run. This field is optional, and the default is 1 if it is not passed in. This means that a full validation of the fields will be performed. Valid verification codes: - 1 = Full Account Verification (Card Account, CVN, CAVV, TAVV, Address, Name, eMail, Phone, Identity) - 2 = Card Account Verification - 3 = Address Verification - 4 = Card Authentication Method (CAM) (Cryptogram) - 5 = Cardholder Authentication Verification (CAVV) - 6 = Cardholder Identity Verification - 7 = CVV2 Verification - 8 = eMail Verification - 9 = Name Verification - 10 = Phone Verification



46
47
48
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 46

def 
  @account_verification_code
end

#business_application_id ⇒ Object

Payouts transaction type. Money Transfer (MT) - AA: Account to Account - BI: Bank-Initiated Money Transfer - CD: Cash Deposit - FT: Funds Transfer - LA: Liquid Assets - PP: P2P Money Transfer - WT: Wallet Transfer-Staged Digital Wallet (SDW) Transfer Funds Disbursement (FD) - BB: Business-to-business Supplier Payments - BP: Non-Card Bill Pay - CP: Credit Card Bill Pay - FD: General Funds Disbursements - GD: Government Disbursements and Government Initiated Tax Refunds - GP: Gambling/Gaming Payouts (other than online gaming) - LO: Loyalty Payments - MD: Merchant Settlement - MI: Faster Refunds - OG: Online Gambling Payouts - PD: Payroll and Pension Disbursements - RP: Request-to-Pay Service - TU: Prepaid Card Load Supported BAIs vary by payment gateway and configuration. Clients are responsible for confirming gateway specific BAI availability. Conditional - If not provided in payload, the value is picked from Merchant Configuration.



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

def business_application_id
  @business_application_id
end

#fee_program_id ⇒ Object

Fee Program Indicator. This field identifies the interchange fee program applicable to each financial transaction. Fee program indicator (FPI) values correspond to the fee descriptor and rate for each existing fee program.



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

def fee_program_id
  @fee_program_id
end

#interchange_rate_designator ⇒ Object

The IRD used for clearing the transaction on the Mastercard network. Details - Alphanumeric, length 2 characters. This field is supported for Visa Platform Connect, Chase Paymentech Salem.



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

def interchange_rate_designator
  @interchange_rate_designator
end

#network_partner_id ⇒ Object

Merchant payment gateway ID that is assigned by Mastercard and is provided by the acquirer when a registered merchant payment gateway service provider is involved in the transaction.



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

def network_partner_id
  @network_partner_id
end

#payouts_options ⇒ Object

Returns the value of attribute payouts_options.



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

def payouts_options
  @payouts_options
end

#processing_code ⇒ Object

This field contains coding that identifies (1) the customer transaction type and (2) the customer account types affected by the transaction. Default: 5402 (Original Credit Transaction) Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund.



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

def processing_code
  @processing_code
end

#purpose_of_payment ⇒ Object

This will send purpose of funds code for original credit transactions (OCTs).



40
41
42
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 40

def purpose_of_payment
  @purpose_of_payment
end

#reconciliation_id ⇒ Object

Transaction's reference number.



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

def reconciliation_id
  @reconciliation_id
end

#sharing_group_code ⇒ Object

This U.S.-only field is optionally used by PIN Debit Gateway Service participants (merchants and acquirers) to specify the network access priority. VisaNet checks to determine if there are issuer routing preferences for a network 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 issuer preference. If an preference exists for multiple specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on acquirer routing priorities. Valid Values: ACCEL_EXCHANGE_E CU24_C INTERLINK_G MAESTRO_8 NYCE_Y NYCE_F PULSE_S PULSE_L PULSE_H STAR_N STAR_W STAR_Z STAR_Q STAR_M VISA_V



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

def sharing_group_code
  @sharing_group_code
end

#transaction_type_indicator ⇒ Object

Transaction Type Identifier for Mastercard Send. 3-character code that identifies the transaction type on the Mastercard network. When provided, this value takes priority over businessApplicationId for determining the payment type.



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

def transaction_type_indicator
  @transaction_type_indicator
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 49

def self.attribute_map
  {
    :'business_application_id' => :'businessApplicationId',
    :'payouts_options' => :'payoutsOptions',
    :'fee_program_id' => :'feeProgramId',
    :'network_partner_id' => :'networkPartnerId',
    :'transaction_type_indicator' => :'transactionTypeIndicator',
    :'interchange_rate_designator' => :'interchangeRateDesignator',
    :'processing_code' => :'processingCode',
    :'sharing_group_code' => :'sharingGroupCode',
    :'purpose_of_payment' => :'purposeOfPayment',
    :'reconciliation_id' => :'reconciliationId',
    :'account_verification_code' => :'accountVerificationCode'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'business_application_id' => :'business_application_id',
    :'payouts_options' => :'payouts_options',
    :'fee_program_id' => :'fee_program_id',
    :'network_partner_id' => :'network_partner_id',
    :'transaction_type_indicator' => :'transaction_type_indicator',
    :'interchange_rate_designator' => :'interchange_rate_designator',
    :'processing_code' => :'processing_code',
    :'sharing_group_code' => :'sharing_group_code',
    :'purpose_of_payment' => :'purpose_of_payment',
    :'reconciliation_id' => :'reconciliation_id',
    :'account_verification_code' => :'account_verification_code'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 83

def self.swagger_types
  {
    :'business_application_id' => :'String',
    :'payouts_options' => :'Ptsv1pushfundstransferProcessingInformationPayoutsOptions',
    :'fee_program_id' => :'String',
    :'network_partner_id' => :'String',
    :'transaction_type_indicator' => :'String',
    :'interchange_rate_designator' => :'String',
    :'processing_code' => :'String',
    :'sharing_group_code' => :'String',
    :'purpose_of_payment' => :'String',
    :'reconciliation_id' => :'String',
    :'account_verification_code' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_application_id == o.business_application_id &&
      payouts_options == o.payouts_options &&
      fee_program_id == o.fee_program_id &&
      network_partner_id == o.network_partner_id &&
      transaction_type_indicator == o.transaction_type_indicator &&
      interchange_rate_designator == o.interchange_rate_designator &&
      processing_code == o.processing_code &&
      sharing_group_code == o.sharing_group_code &&
      purpose_of_payment == o.purpose_of_payment &&
      reconciliation_id == o.reconciliation_id &&
       == o.
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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 302

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 368

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 281

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


268
269
270
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



274
275
276
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 274

def hash
  [business_application_id, payouts_options, fee_program_id, network_partner_id, transaction_type_indicator, interchange_rate_designator, processing_code, sharing_group_code, purpose_of_payment, reconciliation_id, ].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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 156

def list_invalid_properties
  invalid_properties = Array.new
  #if !@business_application_id.nil? && @business_application_id !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
    #invalid_properties.push('invalid value for "business_application_id", must conform to the pattern /^(\\s{0,2}|.{2})$/.')
  #end

  #if !@fee_program_id.nil? && @fee_program_id !~ Regexp.new(/^(\\s{0,3}|[a-zA-Z0-9]{3})$/)
    #invalid_properties.push('invalid value for "fee_program_id", must conform to the pattern /^(\\s{0,3}|[a-zA-Z0-9]{3})$/.')
  #end

  #if !@processing_code.nil? && @processing_code !~ Regexp.new(/^(\\s{0,4}|\\d{4})$/)
    #invalid_properties.push('invalid value for "processing_code", must conform to the pattern /^(\\s{0,4}|\\d{4})$/.')
  #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



348
349
350
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 348

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



354
355
356
357
358
359
360
361
362
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 354

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



342
343
344
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 342

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



175
176
177
178
179
180
 
# File 'lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb', line 175

def valid?
  #return false if !@business_application_id.nil? && @business_application_id !~ Regexp.new(/^(\\s{0,2}|.{2})$/)
  #return false if !@fee_program_id.nil? && @fee_program_id !~ Regexp.new(/^(\\s{0,3}|[a-zA-Z0-9]{3})$/)
  #return false if !@processing_code.nil? && @processing_code !~ Regexp.new(/^(\\s{0,4}|\\d{4})$/)
  true
end