Class: OrbipayPaymentsapiClient::PaymentAuthorization

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb

Instance Attribute Summary collapse

Attributes inherited from Base

#api_end_point, #http_status_code, #invocation_context, #live_mode

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#requested_by, #set_api_end_point, #with_context

Constructor Details

#initialize(id_authorization: nil) ⇒ PaymentAuthorization

Returns a new instance of PaymentAuthorization.

Parameters:

  • id_authorization (String) (defaults to: nil) —

    attribute in the form of String.



127
128
129
130
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 127

def initialize(id_authorization: nil)
    @id_authorization = id_authorization
    @id = id_authorization
end

Instance Attribute Details

#audit_info ⇒ AuditInfo (readonly)

Returns The attribute audit_info.

Returns:



65
66
67
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 65

def audit_info
  @audit_info
end

#auth_amount ⇒ String (readonly)

The amount being authorized.

Returns:

  • (String) —

    The attribute auth_amount.



18
19
20
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 18

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.



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 42

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.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 34

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.



46
47
48
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 46

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.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 30

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.



50
51
52
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 50

def custom_fields
  @custom_fields
end

#customer ⇒ Customer (readonly)

Returns The attribute customer.

Returns:

  • (Customer) —

    The attribute customer.



53
54
55
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 53

def customer
  @customer
end

#customer_account ⇒ CustomerAccount (readonly)

Returns The attribute customer_account.

Returns:



59
60
61
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 59

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.



38
39
40
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 38

def entry_time
  @entry_time
end

#funding_account ⇒ FundingAccount (readonly)

Returns The attribute funding_account.

Returns:



56
57
58
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 56

def 
  @funding_account
end

#id ⇒ String (readonly)

The unique identifier assigned by EBPP to the payment authorization.

Returns:

  • (String) —

    The attribute id.



10
11
12
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 10

def id
  @id
end

#id_authorization ⇒ String (readonly)

The unique identifier assigned by EBPP to the payment authorization.

Returns:

  • (String) —

    The attribute id_authorization.



73
74
75
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 73

def id_authorization
  @id_authorization
end

#id_customer ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer.

Returns:

  • (String) —

    The attribute id_customer.



69
70
71
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 69

def id_customer
  @id_customer
end

#payment_auth_reference ⇒ String (readonly)

The unique identifier in the client system for the payment.

Returns:

  • (String) —

    The attribute payment_auth_reference.



6
7
8
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 6

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.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 26

def payment_method
  @payment_method
end

#payment_network_response ⇒ PaymentNetworkResponse (readonly)

Returns The attribute payment_network_response.

Returns:



62
63
64
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 62

def payment_network_response
  @payment_network_response
end

#status ⇒ String (readonly)

The status of the payment.

Returns:

  • (String) —

    The attribute status.



22
23
24
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 22

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the details of payment authorization.

Returns:

  • (String) —

    The attribute url.



14
15
16
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 14

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 77

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', 
    :'id_customer' => :'ID_CUSTOMER', 
    :'id_authorization' => :'ID_AUTHORIZATION' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 102

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' => :'Customer',	
    :'funding_account' => :'FundingAccount',	
    :'customer_account' => :'CustomerAccount',	
    :'payment_network_response' => :'PaymentNetworkResponse',	
    :'audit_info' => :'AuditInfo',	
    :'id_customer' => :'String',	
    :'id_authorization' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 253

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 &&
      id_customer == o.id_customer &&
      id_authorization == o.id_authorization
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



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
358
359
360
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 312

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 391

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 291

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

#cancel(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Returns:



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 217

def cancel(invocation_context: nil, live_mode: nil, api_end_point: nil)
	begin
		Base.instance_method(:with_context).bind(self).call(invocation_context, live_mode: live_mode, api_end_point: api_end_point)
    	OrbipayPaymentsapiClientHandlers::CancelPaymentAuthorizationHandler.new.process(self)
		rescue ApiError => e
			raise OrbipayApiError.new(http_status_code: e.code, response_headers: e.response_headers, timed_out:e.timed_out, response_body: e.response_body, message: e.message,  masked_authorization_string: e.masked_authorization_string, http_request_body: e.request_body, http_request_headers: e.request_headers),nil, e.backtrace
		rescue StandardError => e
			raise OrbipayApiError.new(message: e.message),nil, e.backtrace
		end
end

#cancelled_by(requestor: nil, requestor_type: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • requestor (String) (defaults to: nil) —

    attribute in the form of String.

  • requestor_type (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



203
204
205
206
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 203

def cancelled_by(requestor: nil, requestor_type: nil)
    Base.instance_method(:requested_by).bind(self).call(requestor: requestor, requestor_type: requestor_type)
    self
end

#create(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Returns:



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 230

def create(invocation_context: nil, live_mode: nil, api_end_point: nil)
	begin
		Base.instance_method(:with_context).bind(self).call(invocation_context, live_mode: live_mode, api_end_point: api_end_point)
    	OrbipayPaymentsapiClientHandlers::CreatePaymentAuthorizationHandler.new.process(self)
		rescue ApiError => e
			raise OrbipayApiError.new(http_status_code: e.code, response_headers: e.response_headers, timed_out:e.timed_out, response_body: e.response_body, message: e.message,  masked_authorization_string: e.masked_authorization_string, http_request_body: e.request_body, http_request_headers: e.request_headers),nil, e.backtrace
		rescue StandardError => e
			raise OrbipayApiError.new(message: e.message),nil, e.backtrace
		end
end

#created_by(requestor: nil, requestor_type: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • requestor (String) (defaults to: nil) —

    attribute in the form of String.

  • requestor_type (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



211
212
213
214
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 211

def created_by(requestor: nil, requestor_type: nil)
    Base.instance_method(:requested_by).bind(self).call(requestor: requestor, requestor_type: requestor_type)
    self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


278
279
280
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 278

def eql?(o)
  self == o
end

#for_client(client_key: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • client_key (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



135
136
137
138
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 135

def for_client(client_key: nil)
    super(client_key: client_key)
    self 
end

#for_customer(id_customer: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • id_customer (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



158
159
160
161
162
163
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 158

def for_customer(id_customer: nil)
    @id_customer = id_customer
    @customer = Customer.new
    @customer.set_values(id: id_customer)
    self 
end

#from_account(funding_account: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • funding_account (FundingAccount) (defaults to: nil) —

    attribute in the form of FundingAccount.

Returns:



167
168
169
170
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 167

def (funding_account: nil)
    @funding_account = 
    self 
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 284

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, id_customer, id_authorization].hash
end

#set_values(args) ⇒ Object 



244
245
246
247
248
249
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 244

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_account(customer_account: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • customer_account (CustomerAccount) (defaults to: nil) —

    attribute in the form of CustomerAccount.

Returns:



174
175
176
177
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 174

def (customer_account: nil)
    @customer_account = 
    self 
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 370

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



376
377
378
379
380
381
382
383
384
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 376

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



364
365
366
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 364

def to_s
  to_hash.to_s
end

#vide_channel(channel: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • channel (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



142
143
144
145
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 142

def vide_channel(channel: nil)
    super(channel: channel)
    self 
end

#with_custom_fields(custom_fields: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • custom_fields (Hash<String, String>) (defaults to: nil) —

    attribute in the form of Hash&lt;String, String&gt;.

Returns:



188
189
190
191
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 188

def with_custom_fields(custom_fields: nil)
    @custom_fields = custom_fields
    self 
end

#with_details(auth_amount: nil, card_cvv_number: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • auth_amount (String) (defaults to: nil) —

    attribute in the form of String.

  • card_cvv_number (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



150
151
152
153
154
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 150

def with_details(auth_amount: nil, card_cvv_number: nil)
    @auth_amount = auth_amount
    @card_cvv_number = card_cvv_number
    self 
end

#with_memo(comments: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • comments (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



195
196
197
198
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 195

def with_memo(comments: nil)
    @comments = comments
    self 
end

#with_reference(payment_auth_reference: nil) ⇒ PaymentAuthorization

Returns The Instance of PaymentAuthorization.

Parameters:

  • payment_auth_reference (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



181
182
183
184
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment_authorization.rb', line 181

def with_reference(payment_auth_reference: nil)
    @payment_auth_reference = payment_auth_reference
    self 
end