Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::PaymentAuthorizationResponse

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#audit_info ⇒ AuditInfoVo (readonly)

Returns The attribute audit_info.

Returns:



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

def audit_info
  @audit_info
end

#auth_amount ⇒ String (readonly)

The amount being authorized.

Returns:

  • (String) —

    The attribute auth_amount.



38
39
40
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 38

def auth_amount
  @auth_amount
end

#captured_time ⇒ String (readonly)

The date on which the payment authorization is captured in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000..

Returns:

  • (String) —

    The attribute captured_time.



62
63
64
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 62

def captured_time
  @captured_time
end

#card_cvv_number ⇒ String (readonly)

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

Returns:

  • (String) —

    The attribute card_cvv_number.



54
55
56
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 54

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.



66
67
68
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 66

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.



50
51
52
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 50

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.



70
71
72
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 70

def custom_fields
  @custom_fields
end

#customer ⇒ PaymentAuthCustomerResponse (readonly)

Returns The attribute customer.

Returns:



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

def customer
  @customer
end

#customer_account ⇒ PaymentAuthCustomerAccountResponse (readonly)

Returns The attribute customer_account.

Returns:



79
80
81
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 79

def 
  @customer_account
end

#entry_time ⇒ String (readonly)

The date on which the payment authorization created in UTC timestamp, with ISO8601 format. For e.g., 2019-08-13T09:21:34.359+0000.

Returns:

  • (String) —

    The attribute entry_time.



58
59
60
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 58

def entry_time
  @entry_time
end

#funding_account ⇒ PaymentAuthFundingAccountResponse (readonly)

Returns The attribute funding_account.

Returns:



76
77
78
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 76

def 
  @funding_account
end

#id ⇒ String (readonly)

The unique identifier assigned by EBPP to the payment authorization.

Returns:

  • (String) —

    The attribute id.



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

def id
  @id
end

#payment_auth_reference ⇒ String (readonly)

The unique identifier in the client system for the payment.

Returns:

  • (String) —

    The attribute payment_auth_reference.



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

def payment_auth_reference
  @payment_auth_reference
end

#payment_method ⇒ String (readonly)

The fulfillment method for the payment authorization.

Returns:

  • (String) —

    The attribute payment_method.



46
47
48
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 46

def payment_method
  @payment_method
end

#payment_network_response ⇒ PaymentNetworkResponseVo (readonly)

Returns The attribute payment_network_response.

Returns:



82
83
84
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 82

def payment_network_response
  @payment_network_response
end

#status ⇒ String (readonly)

The status of the payment.

Returns:

  • (String) —

    The attribute status.



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 42

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the details of payment authorization.

Returns:

  • (String) —

    The attribute url.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 34

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 88

def self.attribute_map
  {
    :'payment_auth_reference' => :'payment_auth_reference',
    :'id' => :'id',
    :'url' => :'url',
    :'auth_amount' => :'auth_amount',
    :'status' => :'status',
    :'payment_method' => :'payment_method',
    :'currency_code3d' => :'currency_code3d',
    :'card_cvv_number' => :'card_cvv_number',
    :'entry_time' => :'entry_time',
    :'captured_time' => :'captured_time',
    :'comments' => :'comments',
    :'custom_fields' => :'custom_fields',
    :'customer' => :'customer',
    :'funding_account' => :'funding_account',
    :'customer_account' => :'customer_account',
    :'payment_network_response' => :'payment_network_response',
    :'audit_info' => :'audit_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/payment_authorization_response.rb', line 111

def self.swagger_types
  {
    :'payment_auth_reference' => :'String',
    :'id' => :'String',
    :'url' => :'String',
    :'auth_amount' => :'String',
    :'status' => :'String',
    :'payment_method' => :'String',
    :'currency_code3d' => :'String',
    :'card_cvv_number' => :'String',
    :'entry_time' => :'String',
    :'captured_time' => :'String',
    :'comments' => :'String',
    :'custom_fields' => :'Hash<String, String>',
    :'customer' => :'PaymentAuthCustomerResponse',
    :'funding_account' => :'PaymentAuthFundingAccountResponse',
    :'customer_account' => :'PaymentAuthCustomerAccountResponse',
    :'payment_network_response' => :'PaymentNetworkResponseVo',
    :'audit_info' => :'AuditInfoVo'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_auth_reference == o.payment_auth_reference &&
      id == o.id &&
      url == o.url &&
      auth_amount == o.auth_amount &&
      status == o.status &&
      payment_method == o.payment_method &&
      currency_code3d == o.currency_code3d &&
      card_cvv_number == o.card_cvv_number &&
      entry_time == o.entry_time &&
      captured_time == o.captured_time &&
      comments == o.comments &&
      custom_fields == o.custom_fields &&
      customer == o.customer &&
       == o. &&
       == o. &&
      payment_network_response == o.payment_network_response &&
      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



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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 281

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 360

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 260

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


247
248
249
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 253

def hash
  [payment_auth_reference, id, url, auth_amount, status, payment_method, currency_code3d, card_cvv_number, entry_time, captured_time, comments, custom_fields, customer, , , payment_network_response, audit_info].hash
end

#set_values(args) ⇒ Object 



213
214
215
216
217
218
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 213

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



339
340
341
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 339

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



345
346
347
348
349
350
351
352
353
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 345

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



333
334
335
 
# File 'lib/orbipay_paymentsapi_client/models/payment_authorization_response.rb', line 333

def to_s
  to_hash.to_s
end