Class: CityPayApiClient::AuthResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/auth_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
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
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 208

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::AuthResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::AuthResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'atrn')
    self.atrn = attributes[:'atrn']
  end

  if attributes.key?(:'atsd')
    self.atsd = attributes[:'atsd']
  end

  if attributes.key?(:'authcode')
    self.authcode = attributes[:'authcode']
  end

  if attributes.key?(:'authen_result')
    self.authen_result = attributes[:'authen_result']
  end

  if attributes.key?(:'authorised')
    self.authorised = attributes[:'authorised']
  end

  if attributes.key?(:'avs_result')
    self.avs_result = attributes[:'avs_result']
  end

  if attributes.key?(:'bin_commercial')
    self.bin_commercial = attributes[:'bin_commercial']
  end

  if attributes.key?(:'bin_debit')
    self.bin_debit = attributes[:'bin_debit']
  end

  if attributes.key?(:'bin_description')
    self.bin_description = attributes[:'bin_description']
  end

  if attributes.key?(:'cavv')
    self.cavv = attributes[:'cavv']
  end

  if attributes.key?(:'context')
    self.context = attributes[:'context']
  end

  if attributes.key?(:'csc_result')
    self.csc_result = attributes[:'csc_result']
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.key?(:'datetime')
    self.datetime = attributes[:'datetime']
  end

  if attributes.key?(:'eci')
    self.eci = attributes[:'eci']
  end

  if attributes.key?(:'external_ref')
    self.external_ref = attributes[:'external_ref']
  end

  if attributes.key?(:'external_ref_source')
    self.external_ref_source = attributes[:'external_ref_source']
  end

  if attributes.key?(:'identifier')
    self.identifier = attributes[:'identifier']
  end

  if attributes.key?(:'live')
    self.live = attributes[:'live']
  end

  if attributes.key?(:'maskedpan')
    self.maskedpan = attributes[:'maskedpan']
  end

  if attributes.key?(:'merchantid')
    self.merchantid = attributes[:'merchantid']
  else
    self.merchantid = nil
  end

  if attributes.key?(:'payment_intent_id')
    self.payment_intent_id = attributes[:'payment_intent_id']
  end

  if attributes.key?(:'result')
    self.result = attributes[:'result']
  else
    self.result = nil
  end

  if attributes.key?(:'result_code')
    self.result_code = attributes[:'result_code']
  else
    self.result_code = nil
  end

  if attributes.key?(:'result_message')
    self.result_message = attributes[:'result_message']
  else
    self.result_message = nil
  end

  if attributes.key?(:'scheme')
    self.scheme = attributes[:'scheme']
  end

  if attributes.key?(:'scheme_id')
    self.scheme_id = attributes[:'scheme_id']
  end

  if attributes.key?(:'scheme_logo')
    self. = attributes[:'scheme_logo']
  end

  if attributes.key?(:'sha256')
    self.sha256 = attributes[:'sha256']
  end

  if attributes.key?(:'trans_status')
    self.trans_status = attributes[:'trans_status']
  end

  if attributes.key?(:'transno')
    self.transno = attributes[:'transno']
  end
end

Instance Attribute Details

#amount ⇒ Object

The amount of the transaction processed.



19
20
21
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 19

def amount
  @amount
end

#atrn ⇒ Object

A reference number provided by the acquirer for a transaction it can be used to cross reference transactions with an Acquirers reporting panel.



22
23
24
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 22

def atrn
  @atrn
end

#atsd ⇒ Object

Additional Transaction Security Data used for ecommerce transactions to decipher security capabilities and attempts against a transaction.



25
26
27
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 25

def atsd
  @atsd
end

#authcode ⇒ Object

The authorisation code as returned by the card issuer or acquiring bank when a transaction has successfully been authorised. Authorisation codes contain alphanumeric values. Whilst the code confirms authorisation it should not be used to determine whether a transaction was successfully processed. For instance an auth code may be returned when a transaction has been subsequently declined due to a CSC mismatch.



28
29
30
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 28

def authcode
  @authcode
end

#authen_result ⇒ Object

The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are: <table> <tr> <th>Value</th> <th>Description</th> </tr> <tr> <td>Y</td> <td>Authentication Successful. The Cardholder’s password was successfully validated.</td> </tr> <tr> <td>N</td> <td>Authentication Failed. Customer failed or cancelled authentication, transaction denied.</td> </tr> <tr> <td>A</td> <td>Attempts Processing Performed Authentication could not be completed but a proof of authentication attempt (CAVV) was generated.</td> </tr> <tr> <td>U</td> <td>Authentication Could Not Be Performed Authentication could not be completed, due to technical or other problem.</td> </tr> </table>



31
32
33
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 31

def authen_result
  @authen_result
end

#authorised ⇒ Object

A boolean definition that indicates that the transaction was authorised. It will return false if the transaction was declined, rejected or cancelled due to CSC matching failures. Attention should be referenced to the AuthResult and Response code for accurate determination of the result.



34
35
36
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 34

def authorised
  @authorised
end

#avs_result ⇒ Object

The AVS result codes determine the result of checking the AVS values within the Address Verification fraud system. If a transaction is declined due to the AVS code not matching, this value can help determine the reason for the decline. <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td>Y</td><td>Address and 5 digit post code match</td></tr> <tr><td>M</td><td>Street address and Postal codes match for international transaction</td></tr> <tr><td>U</td><td>No AVS data available from issuer auth system</td></tr> <tr><td>A</td><td>Addres matches, post code does not</td></tr> <tr><td>I</td><td>Address information verified for international transaction</td></tr> <tr><td>Z</td><td>5 digit post code matches, Address does not</td></tr> <tr><td>W</td><td>9 digit post code matches, Address does not</td></tr> <tr><td>X</td><td>Postcode and address match</td></tr> <tr><td>B</td><td>Postal code not verified due to incompatible formats</td></tr> <tr><td>P</td><td>Postal codes match. Street address not verified due to to incompatible formats</td></tr> <tr><td>E</td><td>AVS Error</td></tr> <tr><td>C</td><td>Street address and Postal code not verified due to incompatible formats</td></tr> <tr><td>D</td><td>Street address and postal codes match</td></tr> <tr><td> </td><td>No information</td></tr> <tr><td>N</td><td>Neither postcode nor address match</td></tr> <tr><td>R</td><td>Retry, System unavailble or Timed Out</td></tr> <tr><td>S</td><td>AVS Service not supported by issuer or processor</td></tr> <tr><td>G</td><td>Issuer does not participate in AVS</td></tr> </table>



37
38
39
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 37

def avs_result
  @avs_result
end

#bin_commercial ⇒ Object

Determines whether the bin range was found to be a commercial or business card.



40
41
42
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 40

def bin_commercial
  @bin_commercial
end

#bin_debit ⇒ Object

Determines whether the bin range was found to be a debit card. If false the card was considered as a credit card.



43
44
45
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 43

def bin_debit
  @bin_debit
end

#bin_description ⇒ Object

A description of the bin range found for the card.



46
47
48
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 46

def bin_description
  @bin_description
end

#cavv ⇒ Object

The cardholder authentication verification value which can be returned for verification purposes of the authenticated transaction for dispute realisation. The value is considered sensitive in the realm of PCI-3DS and is masked.



49
50
51
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 49

def cavv
  @cavv
end

#context ⇒ Object

The context which processed the transaction, can be used for support purposes to trace transactions.



52
53
54
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 52

def context
  @context
end

#csc_result ⇒ Object

The CSC result codes determine the result of checking the provided CSC value within the Card Security Code fraud system. If a transaction is declined due to the CSC code not matching, this value can help determine the reason for the decline. <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td> </td><td>No information</td></tr> <tr><td>M</td><td>Card verification data matches</td></tr> <tr><td>N</td><td>Card verification data was checked but did not match</td></tr> <tr><td>P</td><td>Card verification was not processed</td></tr> <tr><td>S</td><td>The card verification data should be on the card but the merchant indicates that it is not</td></tr> <tr><td>U</td><td>The card issuer is not certified</td></tr> </table>



55
56
57
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 55

def csc_result
  @csc_result
end

#currency ⇒ Object

The currency the transaction was processed in. This is an ‘ISO4217` alpha currency value.



58
59
60
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 58

def currency
  @currency
end

#datetime ⇒ Object

The UTC date time of the transaction in ISO data time format.



61
62
63
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 61

def datetime
  @datetime
end

#eci ⇒ Object

An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure.



64
65
66
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 64

def eci
  @eci
end

#external_ref ⇒ Object

An external ref if supplied.



67
68
69
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 67

def external_ref
  @external_ref
end

#external_ref_source ⇒ Object

An external ref source if supplied.



70
71
72
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 70

def external_ref_source
  @external_ref_source
end

#identifier ⇒ Object

The identifier provided within the request.



73
74
75
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 73

def identifier
  @identifier
end

#live ⇒ Object

Used to identify that a transaction was processed on a live authorisation platform.



76
77
78
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 76

def live
  @live
end

#maskedpan ⇒ Object

A masked value of the card number used for processing displaying limited values that can be used on a receipt.



79
80
81
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 79

def maskedpan
  @maskedpan
end

#merchantid ⇒ Object

The merchant id that processed this transaction.



82
83
84
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 82

def merchantid
  @merchantid
end

#payment_intent_id ⇒ Object

A payment intent id for the authorisation if it exists.



85
86
87
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 85

def payment_intent_id
  @payment_intent_id
end

#result ⇒ Object

An integer result that indicates the outcome of the transaction. The Code value below maps to the result value <table> <tr> <th>Code</th> <th>Abbrev</th> <th>Description</th> </tr> <tr><td>0</td><td>Declined</td><td>Declined</td></tr> <tr><td>1</td><td>Accepted</td><td>Accepted</td></tr> <tr><td>2</td><td>Rejected</td><td>Rejected</td></tr> <tr><td>3</td><td>Not Attempted</td><td>Not Attempted</td></tr> <tr><td>4</td><td>Referred</td><td>Referred</td></tr> <tr><td>5</td><td>PinRetry</td><td>Perform PIN Retry</td></tr> <tr><td>6</td><td>ForSigVer</td><td>Force Signature Verification</td></tr> <tr><td>7</td><td>Hold</td><td>Hold</td></tr> <tr><td>8</td><td>SecErr</td><td>Security Error</td></tr> <tr><td>9</td><td>CallAcq</td><td>Call Acquirer</td></tr> <tr><td>10</td><td>DNH</td><td>Do Not Honour</td></tr> <tr><td>11</td><td>RtnCrd</td><td>Retain Card</td></tr> <tr><td>12</td><td>ExprdCrd</td><td>Expired Card</td></tr> <tr><td>13</td><td>InvldCrd</td><td>Invalid Card No</td></tr> <tr><td>14</td><td>PinExcd</td><td>Pin Tries Exceeded</td></tr> <tr><td>15</td><td>PinInvld</td><td>Pin Invalid</td></tr> <tr><td>16</td><td>AuthReq</td><td>Authentication Required</td></tr> <tr><td>17</td><td>AuthenFail</td><td>Authentication Failed</td></tr> <tr><td>18</td><td>Verified</td><td>Card Verified</td></tr> <tr><td>19</td><td>Cancelled</td><td>Cancelled</td></tr> <tr><td>20</td><td>Un</td><td>Unknown</td></tr> <tr><td>21</td><td>Challenged</td><td>Challenged</td></tr> <tr><td>22</td><td>Decoupled</td><td>Decoupled</td></tr> <tr><td>23</td><td>Denied</td><td>Permission Denied</td></tr> </table>



88
89
90
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 88

def result
  @result
end

#result_code ⇒ Object

The result code as defined in the Response Codes Reference for example 000 is an accepted live transaction whilst 001 is an accepted test transaction. Result codes identify the source of success and failure. Codes may start with an alpha character i.e. C001 indicating a type of error such as a card validation error.



91
92
93
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 91

def result_code
  @result_code
end

#result_message ⇒ Object

The message regarding the result which provides further narrative to the result code.



94
95
96
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 94

def result_message
  @result_message
end

#scheme ⇒ Object

The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.



97
98
99
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 97

def scheme
  @scheme
end

#scheme_id ⇒ Object

The name of the card scheme of the transaction such as VI or MC.



100
101
102
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 100

def scheme_id
  @scheme_id
end

#scheme_logo ⇒ Object

A url containing a logo of the card scheme.



103
104
105
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 103

def 
  
end

#sha256 ⇒ Object

A SHA256 digest value of the transaction used to validate the response data The digest is calculated by concatenating * authcode * amount * response_code * merchant_id * trans_no * identifier * licence_key - which is not provided in the response.



106
107
108
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 106

def sha256
  @sha256
end

#trans_status ⇒ Object

Used to identify the status of a transaction. The status is used to track a transaction through its life cycle. <table> <tr> <th>Id</th> <th>Description</th> </tr> <tr> <td>O</td> <td>Transaction is open for settlement</td> </tr> <tr> <td>A</td> <td>Transaction is assigned for settlement and can no longer be voided</td> </tr> <tr> <td>S</td> <td>Transaction has been settled</td> </tr> <tr> <td>D</td> <td>Transaction has been declined</td> </tr> <tr> <td>R</td> <td>Transaction has been rejected</td> </tr> <tr> <td>P</td> <td>Transaction has been authorised only and awaiting a capture. Used in pre-auth situations</td> </tr> <tr> <td>C</td> <td>Transaction has been cancelled</td> </tr> <tr> <td>E</td> <td>Transaction has expired</td> </tr> <tr> <td>I</td> <td>Transaction has been initialised but no action was able to be carried out</td> </tr> <tr> <td>H</td> <td>Transaction is awaiting authorisation</td> </tr> <tr> <td>.</td> <td>Transaction is on hold</td> </tr> <tr> <td>V</td> <td>Transaction has been verified</td> </tr> </table>



109
110
111
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 109

def trans_status
  @trans_status
end

#transno ⇒ Object

The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.



112
113
114
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 112

def transno
  @transno
end

Class Method Details

._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



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 472

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = CityPayApiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



153
154
155
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 153

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



158
159
160
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 158

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 115

def self.attribute_map
  {
    :'amount' => :'amount',
    :'atrn' => :'atrn',
    :'atsd' => :'atsd',
    :'authcode' => :'authcode',
    :'authen_result' => :'authen_result',
    :'authorised' => :'authorised',
    :'avs_result' => :'avs_result',
    :'bin_commercial' => :'bin_commercial',
    :'bin_debit' => :'bin_debit',
    :'bin_description' => :'bin_description',
    :'cavv' => :'cavv',
    :'context' => :'context',
    :'csc_result' => :'csc_result',
    :'currency' => :'currency',
    :'datetime' => :'datetime',
    :'eci' => :'eci',
    :'external_ref' => :'external-ref',
    :'external_ref_source' => :'external-ref-source',
    :'identifier' => :'identifier',
    :'live' => :'live',
    :'maskedpan' => :'maskedpan',
    :'merchantid' => :'merchantid',
    :'payment_intent_id' => :'payment_intent_id',
    :'result' => :'result',
    :'result_code' => :'result_code',
    :'result_message' => :'result_message',
    :'scheme' => :'scheme',
    :'scheme_id' => :'scheme_id',
    :'scheme_logo' => :'scheme_logo',
    :'sha256' => :'sha256',
    :'trans_status' => :'trans_status',
    :'transno' => :'transno'
  }
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



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 448

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



201
202
203
204
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 201

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 163

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'atrn' => :'String',
    :'atsd' => :'String',
    :'authcode' => :'String',
    :'authen_result' => :'String',
    :'authorised' => :'Boolean',
    :'avs_result' => :'String',
    :'bin_commercial' => :'Boolean',
    :'bin_debit' => :'Boolean',
    :'bin_description' => :'String',
    :'cavv' => :'String',
    :'context' => :'String',
    :'csc_result' => :'String',
    :'currency' => :'String',
    :'datetime' => :'Time',
    :'eci' => :'String',
    :'external_ref' => :'String',
    :'external_ref_source' => :'String',
    :'identifier' => :'String',
    :'live' => :'Boolean',
    :'maskedpan' => :'String',
    :'merchantid' => :'Integer',
    :'payment_intent_id' => :'String',
    :'result' => :'Integer',
    :'result_code' => :'String',
    :'result_message' => :'String',
    :'scheme' => :'String',
    :'scheme_id' => :'String',
    :'scheme_logo' => :'String',
    :'sha256' => :'String',
    :'trans_status' => :'String',
    :'transno' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 396

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      atrn == o.atrn &&
      atsd == o.atsd &&
      authcode == o.authcode &&
      authen_result == o.authen_result &&
      authorised == o.authorised &&
      avs_result == o.avs_result &&
      bin_commercial == o.bin_commercial &&
      bin_debit == o.bin_debit &&
      bin_description == o.bin_description &&
      cavv == o.cavv &&
      context == o.context &&
      csc_result == o.csc_result &&
      currency == o.currency &&
      datetime == o.datetime &&
      eci == o.eci &&
      external_ref == o.external_ref &&
      external_ref_source == o.external_ref_source &&
      identifier == o.identifier &&
      live == o.live &&
      maskedpan == o.maskedpan &&
      merchantid == o.merchantid &&
      payment_intent_id == o.payment_intent_id &&
      result == o.result &&
      result_code == o.result_code &&
      result_message == o.result_message &&
      scheme == o.scheme &&
      scheme_id == o.scheme_id &&
       == o. &&
      sha256 == o.sha256 &&
      trans_status == o.trans_status &&
      transno == o.transno
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



543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 543

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


435
436
437
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 435

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



441
442
443
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 441

def hash
  [amount, atrn, atsd, authcode, authen_result, authorised, avs_result, bin_commercial, bin_debit, bin_description, cavv, context, csc_result, currency, datetime, eci, external_ref, external_ref_source, identifier, live, maskedpan, merchantid, payment_intent_id, result, result_code, result_message, scheme, scheme_id, , sha256, trans_status, transno].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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 361

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @merchantid.nil?
    invalid_properties.push('invalid value for "merchantid", merchantid cannot be nil.')
  end

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

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

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



519
520
521
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 519

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



525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 525

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



513
514
515
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 513

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



385
386
387
388
389
390
391
392
 
# File 'lib/citypay_api_client/models/auth_response.rb', line 385

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @merchantid.nil?
  return false if @result.nil?
  return false if @result_code.nil?
  return false if @result_message.nil?
  true
end