Class: OrbipayPaymentsapiClient::Payment

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/payment.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_payment: nil) ⇒ Payment

Returns a new instance of Payment.

Parameters:

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

    attribute in the form of String.



186
187
188
189
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 186

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

Instance Attribute Details

#amount ⇒ String (readonly)

The amount being paid. In case the payment_amount_type is 'discounted_amount', 'penalty_amount' or 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

Returns:

  • (String) —

    The attribute amount.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 37

def amount
  @amount
end

#audit_info ⇒ AuditInfo (readonly)

Returns The attribute audit_info.

Returns:



104
105
106
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 104

def audit_info
  @audit_info
end

#card_cvv_number ⇒ String (readonly)

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

Returns:

  • (String) —

    The attribute card_cvv_number.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 41

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 (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Returns:

  • (String) —

    The attribute comments.



85
86
87
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 85

def comments
  @comments
end

#confirmation_number ⇒ String (readonly)

The confirmation number or reference provided to the customer for the payment.

Returns:

  • (String) —

    The attribute confirmation_number.



25
26
27
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 25

def confirmation_number
  @confirmation_number
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 Orbipay. This defaults to USD.

Returns:

  • (String) —

    The attribute currency_code3d.



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 33

def currency_code3d
  @currency_code3d
end

#custom_fields ⇒ Hash<String, String> (readonly)

The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay 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 Orbipay, would be accepted in the requests.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



29
30
31
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 29

def custom_fields
  @custom_fields
end

#customer ⇒ Customer (readonly)

Returns The attribute customer.

Returns:

  • (Customer) —

    The attribute customer.



92
93
94
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 92

def customer
  @customer
end

#customer_account ⇒ CustomerAccount (readonly)

Returns The attribute customer_account.

Returns:



98
99
100
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 98

def 
  @customer_account
end

#deleted ⇒ String (readonly)

The status of payment which says whether the payment is deleted or not

Returns:

  • (String) —

    The attribute deleted.



89
90
91
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 89

def deleted
  @deleted
end

#expected_payment_settlement_date ⇒ String (readonly)

The date on which the payment is expected to be settled with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute expected_payment_settlement_date.



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

def expected_payment_settlement_date
  @expected_payment_settlement_date
end

#fee ⇒ Fee (readonly)

Returns The attribute fee.

Returns:

  • (Fee) —

    The attribute fee.



13
14
15
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 13

def fee
  @fee
end

#funding_account ⇒ FundingAccount (readonly)

Returns The attribute funding_account.

Returns:



95
96
97
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 95

def 
  @funding_account
end

#id ⇒ String (readonly)

The unique identifier assigned by Orbipay to the payment.

Returns:

  • (String) —

    The attribute id.



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

def id
  @id
end

#id_customer ⇒ String (readonly)

The unique identifier assigned by EBPP to the customer.

Returns:

  • (String) —

    The attribute id_customer.



108
109
110
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 108

def id_customer
  @id_customer
end

#id_payment ⇒ String (readonly)

The unique identifier assigned by EBPP to the payment.

Returns:

  • (String) —

    The attribute id_payment.



112
113
114
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 112

def id_payment
  @id_payment
end

#payment_amount_type ⇒ String (readonly)

The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.

Returns:

  • (String) —

    The attribute payment_amount_type.



57
58
59
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 57

def payment_amount_type
  @payment_amount_type
end

#payment_date ⇒ String (readonly)

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute payment_date.



45
46
47
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 45

def payment_date
  @payment_date
end

#payment_entry_date ⇒ String (readonly)

The date on which the payment is captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

Returns:

  • (String) —

    The attribute payment_entry_date.



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

def payment_entry_date
  @payment_entry_date
end

#payment_method ⇒ String (readonly)

The fulfillment method for the payment.

Returns:

  • (String) —

    The attribute payment_method.



21
22
23
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 21

def payment_method
  @payment_method
end

#payment_network_response ⇒ PaymentNetworkResponse (readonly)

Returns The attribute payment_network_response.

Returns:



101
102
103
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 101

def payment_network_response
  @payment_network_response
end

#payment_notification_email ⇒ String (readonly)

The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.

Returns:

  • (String) —

    The attribute payment_notification_email.



81
82
83
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 81

def payment_notification_email
  @payment_notification_email
end

#payment_reference ⇒ String (readonly)

The unique identifier in the client system for the payment.

Returns:

  • (String) —

    The attribute payment_reference.



61
62
63
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 61

def payment_reference
  @payment_reference
end

#payment_request_date ⇒ String (readonly)

The date on which the biller wants the payment to be settled. It must be in ISO8601 full-date format, namely, YYYY-MM-DD. This is applicable only if the client has opted for it.

Returns:

  • (String) —

    The attribute payment_request_date.



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

def payment_request_date
  @payment_request_date
end

#payment_return_date ⇒ String (readonly)

The date on which the ACH returns is received by Orbipay.

Returns:

  • (String) —

    The attribute payment_return_date.



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

def payment_return_date
  @payment_return_date
end

#payment_schedule_type ⇒ String (readonly)

The schedule type for the payment. This defaults to one_time_payment.

Returns:

  • (String) —

    The attribute payment_schedule_type.



49
50
51
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 49

def payment_schedule_type
  @payment_schedule_type
end

#return_code ⇒ String (readonly)

The ACH return code or the chargeback code received from Visa/Mastercard, in the event of returned payments.

Returns:

  • (String) —

    The attribute return_code.



77
78
79
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 77

def return_code
  @return_code
end

#status ⇒ String (readonly)

The status of the payment.

Returns:

  • (String) —

    The attribute status.



17
18
19
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 17

def status
  @status
end

#url ⇒ String (readonly)

This URL fetches the details of payment.

Returns:

  • (String) —

    The attribute url.



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

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 116

def self.attribute_map
  {
    :'id' => :'id', 
    :'url' => :'url', 
    :'fee' => :'fee', 
    :'status' => :'status', 
    :'payment_method' => :'payment_method', 
    :'confirmation_number' => :'confirmation_number', 
    :'custom_fields' => :'custom_fields', 
    :'currency_code3d' => :'currency_code3d', 
    :'amount' => :'amount', 
    :'card_cvv_number' => :'card_cvv_number', 
    :'payment_date' => :'payment_date', 
    :'payment_schedule_type' => :'payment_schedule_type', 
    :'payment_request_date' => :'payment_request_date', 
    :'payment_amount_type' => :'payment_amount_type', 
    :'payment_reference' => :'payment_reference', 
    :'expected_payment_settlement_date' => :'expected_payment_settlement_date', 
    :'payment_entry_date' => :'payment_entry_date', 
    :'payment_return_date' => :'payment_return_date', 
    :'return_code' => :'return_code', 
    :'payment_notification_email' => :'payment_notification_email', 
    :'comments' => :'comments', 
    :'deleted' => :'deleted', 
    :'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_payment' => :'ID_PAYMENT' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 151

def self.swagger_types
  {
    :'id' => :'String',	
    :'url' => :'String',	
    :'fee' => :'Fee',	
    :'status' => :'String',	
    :'payment_method' => :'String',	
    :'confirmation_number' => :'String',	
    :'custom_fields' => :'Hash<String, String>',	
    :'currency_code3d' => :'String',	
    :'amount' => :'String',	
    :'card_cvv_number' => :'String',	
    :'payment_date' => :'String',	
    :'payment_schedule_type' => :'String',	
    :'payment_request_date' => :'String',	
    :'payment_amount_type' => :'String',	
    :'payment_reference' => :'String',	
    :'expected_payment_settlement_date' => :'String',	
    :'payment_entry_date' => :'String',	
    :'payment_return_date' => :'String',	
    :'return_code' => :'String',	
    :'payment_notification_email' => :'String',	
    :'comments' => :'String',	
    :'deleted' => :'String',	
    :'customer' => :'Customer',	
    :'funding_account' => :'FundingAccount',	
    :'customer_account' => :'CustomerAccount',	
    :'payment_network_response' => :'PaymentNetworkResponse',	
    :'audit_info' => :'AuditInfo',	
    :'id_customer' => :'String',	
    :'id_payment' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 381

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      url == o.url &&
      fee == o.fee &&
      status == o.status &&
      payment_method == o.payment_method &&
      confirmation_number == o.confirmation_number &&
      custom_fields == o.custom_fields &&
      currency_code3d == o.currency_code3d &&
      amount == o.amount &&
      card_cvv_number == o.card_cvv_number &&
      payment_date == o.payment_date &&
      payment_schedule_type == o.payment_schedule_type &&
      payment_request_date == o.payment_request_date &&
      payment_amount_type == o.payment_amount_type &&
      payment_reference == o.payment_reference &&
      expected_payment_settlement_date == o.expected_payment_settlement_date &&
      payment_entry_date == o.payment_entry_date &&
      payment_return_date == o.payment_return_date &&
      return_code == o.return_code &&
      payment_notification_email == o.payment_notification_email &&
      comments == o.comments &&
      deleted == o.deleted &&
      customer == o.customer &&
       == o. &&
       == o. &&
      payment_network_response == o.payment_network_response &&
      audit_info == o.audit_info &&
      id_customer == o.id_customer &&
      id_payment == o.id_payment
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



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 450

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



529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 529

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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 429

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

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

Returns The Instance of Payment.

Returns:

  • (Payment) —

    The Instance of Payment.



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 319

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::CreatePaymentHandler.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) ⇒ Payment

Returns The Instance of Payment.

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:

  • (Payment) —

    The Instance of Payment.



289
290
291
292
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 289

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

#delete(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Payment

Returns The Instance of Payment.

Returns:

  • (Payment) —

    The Instance of Payment.



332
333
334
335
336
337
338
339
340
341
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 332

def delete(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::DeletePaymentHandler.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

#deleted_by(requestor: nil, requestor_type: nil) ⇒ Payment

Returns The Instance of Payment.

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:

  • (Payment) —

    The Instance of Payment.



297
298
299
300
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 297

def deleted_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


416
417
418
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 416

def eql?(o)
  self == o
end

#for_client(client_key: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



194
195
196
197
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 194

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

#for_customer(id_customer: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



279
280
281
282
283
284
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 279

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) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of FundingAccount.

Returns:

  • (Payment) —

    The Instance of Payment.



223
224
225
226
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 223

def (funding_account: nil)
    @funding_account = 
    self 
end

#get(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Payment

Returns The Instance of Payment.

Returns:

  • (Payment) —

    The Instance of Payment.



345
346
347
348
349
350
351
352
353
354
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 345

def get(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::GetPaymentHandler.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

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



422
423
424
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 422

def hash
  [id, url, fee, status, payment_method, confirmation_number, custom_fields, currency_code3d, amount, card_cvv_number, payment_date, payment_schedule_type, payment_request_date, payment_amount_type, payment_reference, expected_payment_settlement_date, payment_entry_date, payment_return_date, return_code, payment_notification_email, comments, deleted, customer, , , payment_network_response, audit_info, id_customer, id_payment].hash
end

#retrieved_by(requestor: nil, requestor_type: nil) ⇒ Payment

Returns The Instance of Payment.

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:

  • (Payment) —

    The Instance of Payment.



305
306
307
308
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 305

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

#set_values(args) ⇒ Object 



372
373
374
375
376
377
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 372

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) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of CustomerAccount.

Returns:

  • (Payment) —

    The Instance of Payment.



230
231
232
233
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 230

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



508
509
510
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 508

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



514
515
516
517
518
519
520
521
522
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 514

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



502
503
504
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 502

def to_s
  to_hash.to_s
end

#update(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Payment

Returns The Instance of Payment.

Returns:

  • (Payment) —

    The Instance of Payment.



358
359
360
361
362
363
364
365
366
367
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 358

def update(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::UpdatePaymentHandler.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

#updated_by(requestor: nil, requestor_type: nil) ⇒ Payment

Returns The Instance of Payment.

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:

  • (Payment) —

    The Instance of Payment.



313
314
315
316
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 313

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

#vide_channel(channel: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



201
202
203
204
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 201

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

#with_custom_fields(custom_fields: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

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

Returns:

  • (Payment) —

    The Instance of Payment.



258
259
260
261
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 258

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

#with_details(payment_amount_type: nil, amount: nil, payment_date: nil, payment_request_date: nil, card_cvv_number: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



212
213
214
215
216
217
218
219
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 212

def with_details(payment_amount_type: nil, amount: nil, payment_date: nil, payment_request_date: nil, card_cvv_number: nil)
    @payment_amount_type = payment_amount_type
    @amount = amount
    @payment_date = payment_date
    @payment_request_date = payment_request_date
    @card_cvv_number = card_cvv_number
    self 
end

#with_fee(fee: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

  • fee (Fee) (defaults to: nil) —

    attribute in the form of Fee.

Returns:

  • (Payment) —

    The Instance of Payment.



272
273
274
275
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 272

def with_fee(fee: nil)
    @fee = fee
    self 
end

#with_memo(comments: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



265
266
267
268
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 265

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

#with_payment_notification_email(payment_notification_email: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



244
245
246
247
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 244

def with_payment_notification_email(payment_notification_email: nil)
    @payment_notification_email = payment_notification_email
    self 
end

#with_reference(payment_reference: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



237
238
239
240
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 237

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

#with_status(status: nil) ⇒ Payment

Returns The Instance of Payment.

Parameters:

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

    attribute in the form of String.

Returns:

  • (Payment) —

    The Instance of Payment.



251
252
253
254
 
# File 'lib/orbipay_paymentsapi_client/wrappers/payment.rb', line 251

def with_status(status: nil)
    @status = status
    self 
end