Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::SimplePaymentFundingAccountRequest

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 109

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

  if attributes.has_key?(:'display_text')
    self.display_text = attributes[:'display_text']
  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/simple_payment_funding_account_request.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/simple_payment_funding_account_request.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.

Returns:

  • (String) —

    The attribute account_holder_type.



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

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/simple_payment_funding_account_request.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.



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

def 
  @account_subtype
end

#address ⇒ FundingAccountAddress (readonly)

Returns The attribute address.

Returns:



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

def address
  @address
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.



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

def card_cvv_number
  @card_cvv_number
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.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



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

def custom_fields
  @custom_fields
end

#device_manufacturer_id ⇒ String (readonly)

This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier.

Returns:

  • (String) —

    The attribute device_manufacturer_id.



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

def device_manufacturer_id
  @device_manufacturer_id
end

#display_text ⇒ String (readonly)

UI representation of the account.

Returns:

  • (String) —

    The attribute display_text.



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

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.



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

def expiry_date
  @expiry_date
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/simple_payment_funding_account_request.rb', line 30

def nickname
  @nickname
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 72

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',
    :'device_manufacturer_id' => :'device_manufacturer_id',
    :'display_text' => :'display_text'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 90

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',
    :'device_manufacturer_id' => :'String',
    :'display_text' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 177

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 &&
      device_manufacturer_id == o.device_manufacturer_id &&
      display_text == o.display_text
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



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
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 230

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



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

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 209

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


196
197
198
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 202

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

#set_values(args) ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 167

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



288
289
290
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 288

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



294
295
296
297
298
299
300
301
302
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 294

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



282
283
284
 
# File 'lib/orbipay_paymentsapi_client/models/simple_payment_funding_account_request.rb', line 282

def to_s
  to_hash.to_s
end