Class: CyberSource::PaymentsProductsECheckConfigurationInformationConfigurationsUnderwriting

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentsProductsECheckConfigurationInformationConfigurationsUnderwriting

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
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
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 97

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?(:'standardEntryClassCodes')
    self.standard_entry_class_codes = attributes[:'standardEntryClassCodes']
  else
    self.standard_entry_class_codes = "CCD,PPD,TEL,WEB"
  end

  if attributes.has_key?(:'enableHold')
    self.enable_hold = attributes[:'enableHold']
  else
    self.enable_hold = true
  end

  if attributes.has_key?(:'monthlyTotalTransactionAmountLimit')
    self.monthly_total_transaction_amount_limit = attributes[:'monthlyTotalTransactionAmountLimit']
  end

  if attributes.has_key?(:'holdingDays')
    self.holding_days = attributes[:'holdingDays']
  end

  if attributes.has_key?(:'enableCredits')
    self.enable_credits = attributes[:'enableCredits']
  end

  if attributes.has_key?(:'transactionAmountLimit')
    self.transaction_amount_limit = attributes[:'transactionAmountLimit']
  end

  if attributes.has_key?(:'riskReserveMethod')
    self.risk_reserve_method = attributes[:'riskReserveMethod']
  end

  if attributes.has_key?(:'riskReserveRate')
    self.risk_reserve_rate = attributes[:'riskReserveRate']
  end

  if attributes.has_key?(:'riskReserveTargetAmount')
    self.risk_reserve_target_amount = attributes[:'riskReserveTargetAmount']
  end

  if attributes.has_key?(:'solutionOrganizationId')
    self.solution_organization_id = attributes[:'solutionOrganizationId']
  end
end

Instance Attribute Details

#enable_credits ⇒ Object

Optional Allow Credits (True/False)



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

def enable_credits
  @enable_credits
end

#enable_hold ⇒ Object

Mandatory Determines whether CYBS has placed the merchant on a funding hold This will often be set to True for new merchants until the risk team has completed additional verification of their first transaction. It will be switched to "false" once underwriting review is completed and we are ready to start funding the merchant.



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

def enable_hold
  @enable_hold
end

#holding_days ⇒ Object

Mandatory Funds Hold Days (Number of days funds will be held before it will be deposited into merchant account) 3 digits



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

def holding_days
  @holding_days
end

#monthly_total_transaction_amount_limit ⇒ Object

Mandatory Monthly Maximum total Transaction Amount 12 digit including decimal



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

def monthly_total_transaction_amount_limit
  @monthly_total_transaction_amount_limit
end

#risk_reserve_method ⇒ Object

Mandatory Reserve Method Possible value: - fixed - none Most merchants do not have a reserve attached to their account so the default value would be "none." For a Fixed Reserve, the reserve balance is established by either, (1) a receipt of a lump sum deposit from a merchant, or (2) withholding funds at a Reserve Rate established for the account from each batch settlement until the reserve balance is equal to a set Reserve Target. A Fixed Reserve may also be established by a combination of lump sum deposit and withholding of settlement funds. A Rolling Reserve balance is established by withholding from a merchant’s available settlement funds at a Reserve Rate (percentage) and no Reserve Target is specified. Rather, each amount withheld is retained for a specified number of Reserve Holding Days and then released back to the merchant.



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

def risk_reserve_method
  @risk_reserve_method
end

#risk_reserve_rate ⇒ Object

Mandatory Reserve Rate (% of TPV)=> Relevant for Rolling Reserve and Fixed Reserve The percentage rate at which risk funds are withheld from each eCheck.Net batch settlement.



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

def risk_reserve_rate
  @risk_reserve_rate
end

#risk_reserve_target_amount ⇒ Object

Mandatory Reserve Target (fixed $ amount)=> Relevant for Fixed Reserve ONLY The maximum dollar amount that can be held in Risk Reserve for a fixed reserve. Once risk withholdings reach the Reserve Target established for the eCheck.Net account, a portion of available funds will be deposited to the merchant’s bank account 12 digit including decimal



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

def risk_reserve_target_amount
  @risk_reserve_target_amount
end

#solution_organization_id ⇒ Object

Solution organization id



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

def solution_organization_id
  @solution_organization_id
end

#standard_entry_class_codes ⇒ Object

Mandatory Free-text (csv) Possible values (combination): CCD — Cash Concentration or Disbursement, or CCD, is a charge or refund against a business checking account. One-time or recurring CCD transactions are fund transfers to or from a corporate entity. A standing authorization is required for recurring transactions. PPD — Prearranged Payment and Deposit Entry, or PPD, is a charge or refund against a customer’s checking or savings account. PPD entries can only be originated when payment and deposit terms between the merchant and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions. TEL — Telephone-Initiated Entry, or TEL, is a one-time charge against a customer’s checking or savings account. TEL transactions can only be originated when a business relationship between the merchant and the customer already exists; or if a relationship does not exist, then only when the customer initiates the telephone call to the merchant. Payment authorization is obtained from the customer by telephone. WEB — Internet-Initiated Entry or WEB is a charge against a customer’s checking or savings account. One-time or recurring WEB transactions are originated through the Internet. Payment authorization is also obtained from the customer through the Internet.



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

def standard_entry_class_codes
  @standard_entry_class_codes
end

#transaction_amount_limit ⇒ Object

Mandatory Maximum total Transaction Amount This is a per transaction limit. For example, the merchant is limited to processing transactions under $100 12 digits (including decimal - USD only)



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

def transaction_amount_limit
  @transaction_amount_limit
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'standard_entry_class_codes' => :'standardEntryClassCodes',
    :'enable_hold' => :'enableHold',
    :'monthly_total_transaction_amount_limit' => :'monthlyTotalTransactionAmountLimit',
    :'holding_days' => :'holdingDays',
    :'enable_credits' => :'enableCredits',
    :'transaction_amount_limit' => :'transactionAmountLimit',
    :'risk_reserve_method' => :'riskReserveMethod',
    :'risk_reserve_rate' => :'riskReserveRate',
    :'risk_reserve_target_amount' => :'riskReserveTargetAmount',
    :'solution_organization_id' => :'solutionOrganizationId'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'standard_entry_class_codes' => :'standard_entry_class_codes',
    :'enable_hold' => :'enable_hold',
    :'monthly_total_transaction_amount_limit' => :'monthly_total_transaction_amount_limit',
    :'holding_days' => :'holding_days',
    :'enable_credits' => :'enable_credits',
    :'transaction_amount_limit' => :'transaction_amount_limit',
    :'risk_reserve_method' => :'risk_reserve_method',
    :'risk_reserve_rate' => :'risk_reserve_rate',
    :'risk_reserve_target_amount' => :'risk_reserve_target_amount',
    :'solution_organization_id' => :'solution_organization_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'standard_entry_class_codes' => :'String',
    :'enable_hold' => :'BOOLEAN',
    :'monthly_total_transaction_amount_limit' => :'Float',
    :'holding_days' => :'Float',
    :'enable_credits' => :'BOOLEAN',
    :'transaction_amount_limit' => :'Float',
    :'risk_reserve_method' => :'String',
    :'risk_reserve_rate' => :'Float',
    :'risk_reserve_target_amount' => :'Float',
    :'solution_organization_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      standard_entry_class_codes == o.standard_entry_class_codes &&
      enable_hold == o.enable_hold &&
      monthly_total_transaction_amount_limit == o.monthly_total_transaction_amount_limit &&
      holding_days == o.holding_days &&
      enable_credits == o.enable_credits &&
      transaction_amount_limit == o.transaction_amount_limit &&
      risk_reserve_method == o.risk_reserve_method &&
      risk_reserve_rate == o.risk_reserve_rate &&
      risk_reserve_target_amount == o.risk_reserve_target_amount &&
      solution_organization_id == o.solution_organization_id
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 254

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



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

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 233

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


220
221
222
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 226

def hash
  [standard_entry_class_codes, enable_hold, monthly_total_transaction_amount_limit, holding_days, enable_credits, transaction_amount_limit, risk_reserve_method, risk_reserve_rate, risk_reserve_target_amount, solution_organization_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



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

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

  if @enable_hold.nil?
    invalid_properties.push('invalid value for "enable_hold", enable_hold cannot be nil.')
  end

  if @monthly_total_transaction_amount_limit.nil?
    invalid_properties.push('invalid value for "monthly_total_transaction_amount_limit", monthly_total_transaction_amount_limit cannot be nil.')
  end

  if @holding_days.nil?
    invalid_properties.push('invalid value for "holding_days", holding_days cannot be nil.')
  end

  if @transaction_amount_limit.nil?
    invalid_properties.push('invalid value for "transaction_amount_limit", transaction_amount_limit cannot be nil.')
  end

  if @risk_reserve_method.nil?
    invalid_properties.push('invalid value for "risk_reserve_method", risk_reserve_method cannot be nil.')
  end

  if @risk_reserve_rate.nil?
    invalid_properties.push('invalid value for "risk_reserve_rate", risk_reserve_rate cannot be nil.')
  end

  if @risk_reserve_target_amount.nil?
    invalid_properties.push('invalid value for "risk_reserve_target_amount", risk_reserve_target_amount 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



300
301
302
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 300

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



306
307
308
309
310
311
312
313
314
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 306

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



294
295
296
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 294

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



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/cybersource_rest_client/models/payments_products_e_check_configuration_information_configurations_underwriting.rb', line 189

def valid?
  return false if @standard_entry_class_codes.nil?
  return false if @enable_hold.nil?
  return false if @monthly_total_transaction_amount_limit.nil?
  return false if @holding_days.nil?
  return false if @transaction_amount_limit.nil?
  return false if @risk_reserve_method.nil?
  return false if @risk_reserve_rate.nil?
  return false if @risk_reserve_target_amount.nil?
  true
end