Class: CyberSource::Ptsv2creditsProcessingInformationBankTransferOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2creditsProcessingInformationBankTransferOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 66

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

  if attributes.has_key?(:'secCode')
    self.sec_code = attributes[:'secCode']
  end

  if attributes.has_key?(:'terminalCity')
    self.terminal_city = attributes[:'terminalCity']
  end

  if attributes.has_key?(:'terminalState')
    self.terminal_state = attributes[:'terminalState']
  end

  if attributes.has_key?(:'effectiveDate')
    self.effective_date = attributes[:'effectiveDate']
  end

  if attributes.has_key?(:'partialPaymentId')
    self.partial_payment_id = attributes[:'partialPaymentId']
  end

  if attributes.has_key?(:'settlementMethod')
    self.settlement_method = attributes[:'settlementMethod']
  end
end

Instance Attribute Details

#customer_memo ⇒ Object

Payment related information. This information is included on the customer’s statement.



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

def customer_memo
  @customer_memo
end

#effective_date ⇒ Object

Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: ‘MMDDYYYY` Supported only for the CyberSource ACH Service.



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

def effective_date
  @effective_date
end

#partial_payment_id ⇒ Object

Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see ‘partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)



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

def partial_payment_id
  @partial_payment_id
end

#sec_code ⇒ Object

Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - ‘ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)



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

def sec_code
  @sec_code
end

#settlement_method ⇒ Object

Method used for settlement. Possible values: - ‘A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)



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

def settlement_method
  @settlement_method
end

#terminal_city ⇒ Object

City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.



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

def terminal_city
  @terminal_city
end

#terminal_state ⇒ Object

State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.



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

def terminal_state
  @terminal_state
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'customer_memo' => :'customerMemo',
    :'sec_code' => :'secCode',
    :'terminal_city' => :'terminalCity',
    :'terminal_state' => :'terminalState',
    :'effective_date' => :'effectiveDate',
    :'partial_payment_id' => :'partialPaymentId',
    :'settlement_method' => :'settlementMethod'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 52

def self.swagger_types
  {
    :'customer_memo' => :'String',
    :'sec_code' => :'String',
    :'terminal_city' => :'String',
    :'terminal_state' => :'String',
    :'effective_date' => :'String',
    :'partial_payment_id' => :'String',
    :'settlement_method' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_memo == o.customer_memo &&
      sec_code == o.sec_code &&
      terminal_city == o.terminal_city &&
      terminal_state == o.terminal_state &&
      effective_date == o.effective_date &&
      partial_payment_id == o.partial_payment_id &&
      settlement_method == o.settlement_method
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 269

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 335

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



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

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


235
236
237
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 241

def hash
  [customer_memo, sec_code, terminal_city, terminal_state, effective_date, partial_payment_id, settlement_method].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@customer_memo.nil? && @customer_memo.to_s.length > 80
    invalid_properties.push('invalid value for "customer_memo", the character length must be smaller than or equal to 80.')
  end

  if !@sec_code.nil? && @sec_code.to_s.length > 3
    invalid_properties.push('invalid value for "sec_code", the character length must be smaller than or equal to 3.')
  end

  if !@terminal_city.nil? && @terminal_city.to_s.length > 4
    invalid_properties.push('invalid value for "terminal_city", the character length must be smaller than or equal to 4.')
  end

  if !@terminal_state.nil? && @terminal_state.to_s.length > 2
    invalid_properties.push('invalid value for "terminal_state", the character length must be smaller than or equal to 2.')
  end

  if !@effective_date.nil? && @effective_date.to_s.length > 8
    invalid_properties.push('invalid value for "effective_date", the character length must be smaller than or equal to 8.')
  end

  if !@partial_payment_id.nil? && @partial_payment_id.to_s.length > 25
    invalid_properties.push('invalid value for "partial_payment_id", the character length must be smaller than or equal to 25.')
  end

  if !@settlement_method.nil? && @settlement_method.to_s.length > 1
    invalid_properties.push('invalid value for "settlement_method", the character length must be smaller than or equal to 1.')
  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



315
316
317
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 315

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



321
322
323
324
325
326
327
328
329
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 321

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



309
310
311
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 309

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



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb', line 138

def valid?
  return false if !@customer_memo.nil? && @customer_memo.to_s.length > 80
  return false if !@sec_code.nil? && @sec_code.to_s.length > 3
  return false if !@terminal_city.nil? && @terminal_city.to_s.length > 4
  return false if !@terminal_state.nil? && @terminal_state.to_s.length > 2
  return false if !@effective_date.nil? && @effective_date.to_s.length > 8
  return false if !@partial_payment_id.nil? && @partial_payment_id.to_s.length > 25
  return false if !@settlement_method.nil? && @settlement_method.to_s.length > 1
  true
end