Class: CyberSource::UnifiedriskPaymentWire

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

Overview

Container for Fedwire and SWIFT wire transfer specific fields, including IMAD/OMAD tracking data, OFAC compliance flags, and inter-agent messaging

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UnifiedriskPaymentWire

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 121

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

  if attributes.has_key?(:'agentToAgentMsg')
    self.agent_to_agent_msg = attributes[:'agentToAgentMsg']
  end

  if attributes.has_key?(:'businessFunctionCode')
    self.business_function_code = attributes[:'businessFunctionCode']
  end

  if attributes.has_key?(:'debtorToCreditorMsg')
    self.debtor_to_creditor_msg = attributes[:'debtorToCreditorMsg']
  end

  if attributes.has_key?(:'imadInputCycleDate')
    self.imad_input_cycle_date = attributes[:'imadInputCycleDate']
  end

  if attributes.has_key?(:'imadInputSequenceNumber')
    self.imad_input_sequence_number = attributes[:'imadInputSequenceNumber']
  end

  if attributes.has_key?(:'imadInputSource')
    self.imad_input_source = attributes[:'imadInputSource']
  end

  if attributes.has_key?(:'ofacCheckCompletedFlag')
    self.ofac_check_completed_flag = attributes[:'ofacCheckCompletedFlag']
  end

  if attributes.has_key?(:'omadOutputCycleDate')
    self.omad_output_cycle_date = attributes[:'omadOutputCycleDate']
  end

  if attributes.has_key?(:'omadOutputDate')
    self.omad_output_date = attributes[:'omadOutputDate']
  end

  if attributes.has_key?(:'omadOutputDestinationId')
    self.omad_output_destination_id = attributes[:'omadOutputDestinationId']
  end

  if attributes.has_key?(:'omadOutputSequencer')
    self.omad_output_sequencer = attributes[:'omadOutputSequencer']
  end

  if attributes.has_key?(:'omadOutputTime')
    self.omad_output_time = attributes[:'omadOutputTime']
  end

  if attributes.has_key?(:'supervisorOverrideFlag')
    self.supervisor_override_flag = attributes[:'supervisorOverrideFlag']
  end
end

Instance Attribute Details

#addenda ⇒ Object

Additional payment information or remittance data appended to the wire transfer message for beneficiary reconciliation purposes



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

def addenda
  @addenda
end

#agent_to_agent_msg ⇒ Object

Free-text message transmitted between the originating and receiving financial agents for internal communication or compliance notes



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

def agent_to_agent_msg
  @agent_to_agent_msg
end

#business_function_code ⇒ Object

Fedwire Business Function Code indicating the specific type of wire transfer (e.g., BTR for bank transfer, FFR for fed funds returned)



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

def business_function_code
  @business_function_code
end

#debtor_to_creditor_msg ⇒ Object

Message from the payer to the payee providing remittance information, invoice references, or payment instructions



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

def debtor_to_creditor_msg
  @debtor_to_creditor_msg
end

#imad_input_cycle_date ⇒ Object

Fedwire IMAD (Input Message Accountability Data) input cycle date in YYYYMMDD format, used to uniquely identify outgoing wire messages



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

def imad_input_cycle_date
  @imad_input_cycle_date
end

#imad_input_sequence_number ⇒ Object

Sequential number within the IMAD cycle identifying this specific wire message within the processing day



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

def imad_input_sequence_number
  @imad_input_sequence_number
end

#imad_input_source ⇒ Object

Source identifier in the IMAD, typically the Federal Reserve district code and routing information of the originating institution



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

def imad_input_source
  @imad_input_source
end

#ofac_check_completed_flag ⇒ Object

Indicates whether OFAC (Office of Foreign Assets Control) sanctions screening has been completed for this wire transfer. Required for regulatory compliance



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

def ofac_check_completed_flag
  @ofac_check_completed_flag
end

#omad_output_cycle_date ⇒ Object

Fedwire OMAD (Output Message Accountability Data) output cycle date, used to identify and track the received wire message at the destination institution



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

def omad_output_cycle_date
  @omad_output_cycle_date
end

#omad_output_date ⇒ Object

Date component of the OMAD for the received wire, confirming the settlement date at the receiving institution



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

def omad_output_date
  @omad_output_date
end

#omad_output_destination_id ⇒ Object

Destination routing identifier in the OMAD, identifying the Federal Reserve office that delivered the wire message



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

def omad_output_destination_id
  @omad_output_destination_id
end

#omad_output_sequencer ⇒ Object

Sequential output identifier in the OMAD, used for uniquely identifying wire messages at the receiving end



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

def omad_output_sequencer
  @omad_output_sequencer
end

#omad_output_time ⇒ Object

Time component of the OMAD in HHMM format (24-hour), indicating when the wire was delivered to the receiving institution



54
55
56
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 54

def omad_output_time
  @omad_output_time
end

#supervisor_override_flag ⇒ Object

Indicates whether a supervisor manually overrode a compliance hold or exception flag on this wire transfer. Overrides require audit logging



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

def supervisor_override_flag
  @supervisor_override_flag
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'addenda' => :'addenda',
    :'agent_to_agent_msg' => :'agentToAgentMsg',
    :'business_function_code' => :'businessFunctionCode',
    :'debtor_to_creditor_msg' => :'debtorToCreditorMsg',
    :'imad_input_cycle_date' => :'imadInputCycleDate',
    :'imad_input_sequence_number' => :'imadInputSequenceNumber',
    :'imad_input_source' => :'imadInputSource',
    :'ofac_check_completed_flag' => :'ofacCheckCompletedFlag',
    :'omad_output_cycle_date' => :'omadOutputCycleDate',
    :'omad_output_date' => :'omadOutputDate',
    :'omad_output_destination_id' => :'omadOutputDestinationId',
    :'omad_output_sequencer' => :'omadOutputSequencer',
    :'omad_output_time' => :'omadOutputTime',
    :'supervisor_override_flag' => :'supervisorOverrideFlag'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'addenda' => :'addenda',
    :'agent_to_agent_msg' => :'agent_to_agent_msg',
    :'business_function_code' => :'business_function_code',
    :'debtor_to_creditor_msg' => :'debtor_to_creditor_msg',
    :'imad_input_cycle_date' => :'imad_input_cycle_date',
    :'imad_input_sequence_number' => :'imad_input_sequence_number',
    :'imad_input_source' => :'imad_input_source',
    :'ofac_check_completed_flag' => :'ofac_check_completed_flag',
    :'omad_output_cycle_date' => :'omad_output_cycle_date',
    :'omad_output_date' => :'omad_output_date',
    :'omad_output_destination_id' => :'omad_output_destination_id',
    :'omad_output_sequencer' => :'omad_output_sequencer',
    :'omad_output_time' => :'omad_output_time',
    :'supervisor_override_flag' => :'supervisor_override_flag'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 100

def self.swagger_types
  {
    :'addenda' => :'String',
    :'agent_to_agent_msg' => :'String',
    :'business_function_code' => :'String',
    :'debtor_to_creditor_msg' => :'String',
    :'imad_input_cycle_date' => :'Date',
    :'imad_input_sequence_number' => :'String',
    :'imad_input_source' => :'String',
    :'ofac_check_completed_flag' => :'String',
    :'omad_output_cycle_date' => :'Date',
    :'omad_output_date' => :'Date',
    :'omad_output_destination_id' => :'String',
    :'omad_output_sequencer' => :'String',
    :'omad_output_time' => :'Integer',
    :'supervisor_override_flag' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      addenda == o.addenda &&
      agent_to_agent_msg == o.agent_to_agent_msg &&
      business_function_code == o.business_function_code &&
      debtor_to_creditor_msg == o.debtor_to_creditor_msg &&
      imad_input_cycle_date == o.imad_input_cycle_date &&
      imad_input_sequence_number == o.imad_input_sequence_number &&
      imad_input_source == o.imad_input_source &&
      ofac_check_completed_flag == o.ofac_check_completed_flag &&
      omad_output_cycle_date == o.omad_output_cycle_date &&
      omad_output_date == o.omad_output_date &&
      omad_output_destination_id == o.omad_output_destination_id &&
      omad_output_sequencer == o.omad_output_sequencer &&
      omad_output_time == o.omad_output_time &&
      supervisor_override_flag == o.supervisor_override_flag
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 284

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 350

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 263

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


250
251
252
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 256

def hash
  [addenda, agent_to_agent_msg, business_function_code, debtor_to_creditor_msg, imad_input_cycle_date, imad_input_sequence_number, imad_input_source, ofac_check_completed_flag, omad_output_cycle_date, omad_output_date, omad_output_destination_id, omad_output_sequencer, omad_output_time, supervisor_override_flag].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



186
187
188
189
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 186

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



330
331
332
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 330

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



336
337
338
339
340
341
342
343
344
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 336

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



324
325
326
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 324

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



193
194
195
 
# File 'lib/cybersource_rest_client/models/unifiedrisk_payment_wire.rb', line 193

def valid?
  true
end