Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::AddFundingAccountRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/add_funding_account_request.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 = {}) ⇒ AddFundingAccountRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
153
154
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 103

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

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

Instance Attribute Details

#aba_routing_numberString (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/add_funding_account_request.rb', line 41

def aba_routing_number
  @aba_routing_number
end

#account_holder_nameString (readonly)

The name as specified on the account.

Returns:

  • (String)

    The attribute account_holder_name.



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

def 
  @account_holder_name
end

#account_holder_typeString (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.



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

def 
  @account_holder_type
end

#account_numberString (readonly)

The number or reference that a customer uses to identify the funding account.

Returns:

  • (String)

    The attribute account_number.



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

def 
  @account_number
end

#account_subtypeString (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 account. For e.g., a savings account, a checking account.

Returns:

  • (String)

    The attribute account_subtype.



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

def 
  @account_subtype
end

#addressFundingAccountAddress (readonly)

Returns The attribute address.

Returns:



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

def address
  @address
end

#card_cvv_numberString (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.



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

def card_cvv_number
  @card_cvv_number
end

#commentsString (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.



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

def comments
  @comments
end

#custom_fieldsHash<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.



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

def custom_fields
  @custom_fields
end

#expiry_dateString (readonly)

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

Returns:

  • (String)

    The attribute expiry_date.



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

def expiry_date
  @expiry_date
end

#nicknameString (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/add_funding_account_request.rb', line 30

def nickname
  @nickname
end

Class Method Details

.attribute_mapObject

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 68

def self.attribute_map
  {
    :'account_holder_name' => :'account_holder_name',
    :'nickname' => :'nickname',
    :'address' => :'address',
    :'account_number' => :'account_number',
    :'aba_routing_number' => :'aba_routing_number',
    :'expiry_date' => :'expiry_date',
    :'account_holder_type' => :'account_holder_type',
    :'custom_fields' => :'custom_fields',
    :'account_subtype' => :'account_subtype',
    :'card_cvv_number' => :'card_cvv_number',
    :'comments' => :'comments'
  }
end

.swagger_typesObject

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 85

def self.swagger_types
  {
    :'account_holder_name' => :'String',
    :'nickname' => :'String',
    :'address' => :'FundingAccountAddress',
    :'account_number' => :'String',
    :'aba_routing_number' => :'String',
    :'expiry_date' => :'String',
    :'account_holder_type' => :'String',
    :'custom_fields' => :'Hash<String, String>',
    :'account_subtype' => :'String',
    :'card_cvv_number' => :'String',
    :'comments' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object)

    Object to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 167

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 &&
      expiry_date == o.expiry_date &&
       == o. &&
      custom_fields == o.custom_fields &&
       == o. &&
      card_cvv_number == o.card_cvv_number &&
      comments == o.comments
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



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 219

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



298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 298

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 198

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


185
186
187
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 185

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



191
192
193
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 191

def hash
  [, nickname, address, , aba_routing_number, expiry_date, , custom_fields, , card_cvv_number, comments].hash
end

#set_values(args) ⇒ Object



157
158
159
160
161
162
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 157

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



277
278
279
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 277

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 283

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



271
272
273
# File 'lib/orbipay_paymentsapi_client/models/add_funding_account_request.rb', line 271

def to_s
  to_hash.to_s
end