Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::FundingAccountResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/funding_account_response.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FundingAccountResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 162

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'custom_fields')
    if (value = attributes[:'custom_fields']).is_a?(Hash)
      self.custom_fields = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aba_routing_number ⇒ String (readonly)

The ABA/Routing number for the bank account.

Returns:

  • (String) —

    The attribute aba_routing_number.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 41

def aba_routing_number
  @aba_routing_number
end

#account_holder_name ⇒ String (readonly)

The name as specified on the account.

Returns:

  • (String) —

    The attribute account_holder_name.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 26

def 
  @account_holder_name
end

#account_holder_type ⇒ String (readonly)

The type of ownership for the funding account. This is applicable only in the case of bank accounts and it is defaults to personal.

Returns:

  • (String) —

    The attribute account_holder_type.



57
58
59
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 57

def 
  @account_holder_type
end

#account_number ⇒ String (readonly)

The number or reference that a customer uses to identify the funding account. In case of Apple Pay, this is the device-specific account number of the card.

Returns:

  • (String) —

    The attribute account_number.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 37

def 
  @account_number
end

#account_subtype ⇒ String (readonly)

The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.

Returns:

  • (String) —

    The attribute account_subtype.



65
66
67
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 65

def 
  @account_subtype
end

#account_type ⇒ String (readonly)

The type of the funding account.

Returns:

  • (String) —

    The attribute account_type.



89
90
91
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 89

def 
  @account_type
end

#ach_eligible_flag ⇒ String (readonly)

Indicates if the funding account can be debited vide ACH, in case the funding account is a Demand Deposit Account (DDA).

Returns:

  • (String) —

    The attribute ach_eligible_flag.



77
78
79
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 77

def ach_eligible_flag
  @ach_eligible_flag
end

#address ⇒ FundingAccountAddress (readonly)

Returns The attribute address.

Returns:



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 33

def address
  @address
end

#atm_eligible_flag ⇒ String (readonly)

Indicates if the funding account can be debited vide the ATM Rail network, in case the funding account is a Debit Card.

Returns:

  • (String) —

    The attribute atm_eligible_flag.



81
82
83
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 81

def atm_eligible_flag
  @atm_eligible_flag
end

#audit_info ⇒ AuditInfoVo (readonly)

Returns The attribute audit_info.

Returns:



104
105
106
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 104

def audit_info
  @audit_info
end

#card_cvv_number ⇒ String (readonly)

This is never returned by EBPP. This needs to be passed to EBPP when adding or editing a card funding account.

Returns:

  • (String) —

    The attribute card_cvv_number.



85
86
87
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 85

def card_cvv_number
  @card_cvv_number
end

#comments ⇒ String (readonly)

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Returns:

  • (String) —

    The attribute comments.



101
102
103
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 101

def comments
  @comments
end

#currency_code3d ⇒ String (readonly)

The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by EBPP. This defaults to USD.

Returns:

  • (String) —

    The attribute currency_code3d.



49
50
51
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 49

def currency_code3d
  @currency_code3d
end

#custom_fields ⇒ Hash<String, String> (readonly)

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



61
62
63
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 61

def custom_fields
  @custom_fields
end

#display_text ⇒ String (readonly)

UI representation of the account.

Returns:

  • (String) —

    The attribute display_text.



97
98
99
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 97

def display_text
  @display_text
end

#expiry_date ⇒ String (readonly)

The expiry date for the card. This is to be in the format MM/YY.

Returns:

  • (String) —

    The attribute expiry_date.



53
54
55
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 53

def expiry_date
  @expiry_date
end

#id ⇒ String (readonly)

Id is a unique identifier assigned to the funding account in EBPP. A new Id is generated for the funding account when the account number is updated.

Returns:

  • (String) —

    The attribute id.



69
70
71
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 69

def id
  @id
end

#issuer_name ⇒ String (readonly)

The name of the authority that has issued the account. This is relevant only in the case of bank accounts.

Returns:

  • (String) —

    The attribute issuer_name.



45
46
47
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 45

def issuer_name
  @issuer_name
end

#nickname ⇒ String (readonly)

The nickname by which a customer might want to identify the account.

Returns:

  • (String) —

    The attribute nickname.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 30

def nickname
  @nickname
end

#status ⇒ String (readonly)

The status of the funding account in EBPP.

Returns:

  • (String) —

    The attribute status.



93
94
95
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 93

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the funding account details.

Returns:

  • (String) —

    The attribute url.



73
74
75
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 73

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 107

def self.attribute_map
  {
    :'account_holder_name' => :'account_holder_name',
    :'nickname' => :'nickname',
    :'address' => :'address',
    :'account_number' => :'account_number',
    :'aba_routing_number' => :'aba_routing_number',
    :'issuer_name' => :'issuer_name',
    :'currency_code3d' => :'currency_code3d',
    :'expiry_date' => :'expiry_date',
    :'account_holder_type' => :'account_holder_type',
    :'custom_fields' => :'custom_fields',
    :'account_subtype' => :'account_subtype',
    :'id' => :'id',
    :'url' => :'url',
    :'ach_eligible_flag' => :'ach_eligible_flag',
    :'atm_eligible_flag' => :'atm_eligible_flag',
    :'card_cvv_number' => :'card_cvv_number',
    :'account_type' => :'account_type',
    :'status' => :'status',
    :'display_text' => :'display_text',
    :'comments' => :'comments',
    :'audit_info' => :'audit_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 134

def self.swagger_types
  {
    :'account_holder_name' => :'String',
    :'nickname' => :'String',
    :'address' => :'FundingAccountAddress',
    :'account_number' => :'String',
    :'aba_routing_number' => :'String',
    :'issuer_name' => :'String',
    :'currency_code3d' => :'String',
    :'expiry_date' => :'String',
    :'account_holder_type' => :'String',
    :'custom_fields' => :'Hash<String, String>',
    :'account_subtype' => :'String',
    :'id' => :'String',
    :'url' => :'String',
    :'ach_eligible_flag' => :'String',
    :'atm_eligible_flag' => :'String',
    :'card_cvv_number' => :'String',
    :'account_type' => :'String',
    :'status' => :'String',
    :'display_text' => :'String',
    :'comments' => :'String',
    :'audit_info' => :'AuditInfoVo'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



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/orbipay_paymentsapi_client/models/funding_account_response.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      nickname == o.nickname &&
      address == o.address &&
       == o. &&
      aba_routing_number == o.aba_routing_number &&
      issuer_name == o.issuer_name &&
      currency_code3d == o.currency_code3d &&
      expiry_date == o.expiry_date &&
       == o. &&
      custom_fields == o.custom_fields &&
       == o. &&
      id == o.id &&
      url == o.url &&
      ach_eligible_flag == o.ach_eligible_flag &&
      atm_eligible_flag == o.atm_eligible_flag &&
      card_cvv_number == o.card_cvv_number &&
       == o. &&
      status == o.status &&
      display_text == o.display_text &&
      comments == o.comments &&
      audit_info == o.audit_info
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 328

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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 = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 407

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 307

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)
        set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      set_values(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:

  • o (Object) —

    Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


294
295
296
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 300

def hash
  [, nickname, address, , aba_routing_number, issuer_name, currency_code3d, expiry_date, , custom_fields, , id, url, ach_eligible_flag, atm_eligible_flag, card_cvv_number, , status, display_text, comments, audit_info].hash
end

#set_values(args) ⇒ Object 



256
257
258
259
260
261
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 256

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



386
387
388
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 386

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



392
393
394
395
396
397
398
399
400
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 392

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



380
381
382
 
# File 'lib/orbipay_paymentsapi_client/models/funding_account_response.rb', line 380

def to_s
  to_hash.to_s
end