Class: OrbipayPaymentsapiClient::RecordedPayment

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/recorded_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) ⇒ RecordedPayment

Returns a new instance of RecordedPayment.

Parameters:

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

    attribute in the form of String.



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

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 'other', the amount needs to be specified. In other cases, this is derived from the payment_amount_type.

Returns:

  • (String) —

    The attribute amount.



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

def amount
  @amount
end

#audit_info ⇒ AuditInfo (readonly)

Returns The attribute audit_info.

Returns:



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

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



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

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.



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

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 EBPP. This defaults to USD.

Returns:

  • (String) —

    The attribute currency_code3d.



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

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.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



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

def custom_fields
  @custom_fields
end

#customer ⇒ Customer (readonly)

Returns The attribute customer.

Returns:

  • (Customer) —

    The attribute customer.



76
77
78
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 76

def customer
  @customer
end

#customer_account ⇒ CustomerAccount (readonly)

Returns The attribute customer_account.

Returns:



82
83
84
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 82

def 
  @customer_account
end

#fee ⇒ Fee (readonly)

Returns The attribute fee.

Returns:

  • (Fee) —

    The attribute fee.



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

def fee
  @fee
end

#funding_account ⇒ FundingAccount (readonly)

Returns The attribute funding_account.

Returns:



79
80
81
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 79

def 
  @funding_account
end

#id ⇒ String (readonly)

The unique identifier assigned by EBPP to the payment.

Returns:

  • (String) —

    The attribute id.



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

def id
  @id
end

#id_payment ⇒ String (readonly)

The unique identifier assigned by EBPP to the payment.

Returns:

  • (String) —

    The attribute id_payment.



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

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.



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

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/recorded_payment.rb', line 45

def payment_date
  @payment_date
end

#payment_entry_date ⇒ String (readonly)

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

Returns:

  • (String) —

    The attribute payment_entry_date.



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

def payment_entry_date
  @payment_entry_date
end

#payment_method ⇒ String (readonly)

The non fulfillment method for the payment.

Returns:

  • (String) —

    The attribute payment_method.



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

def payment_method
  @payment_method
end

#payment_reference ⇒ String (readonly)

The unique identifier in the client system for the payment.

Returns:

  • (String) —

    The attribute payment_reference.



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

def payment_reference
  @payment_reference
end

#payment_return_date ⇒ String (readonly)

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

Returns:

  • (String) —

    The attribute payment_return_date.



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

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



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

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/recorded_payment.rb', line 17

def status
  @status
end

#token ⇒ String (readonly)

The token is used to uniquely identify the payment, such as the POS token.

Returns:

  • (String) —

    The attribute token.



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

def token
  @token
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/recorded_payment.rb', line 10

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 93

def self.attribute_map
  {
    :'id' => :'id', 
    :'url' => :'url', 
    :'fee' => :'fee', 
    :'status' => :'status', 
    :'payment_method' => :'payment_method', 
    :'token' => :'token', 
    :'confirmation_number' => :'confirmation_number', 
    :'custom_fields' => :'custom_fields', 
    :'currency_code3d' => :'currency_code3d', 
    :'amount' => :'amount', 
    :'payment_date' => :'payment_date', 
    :'payment_schedule_type' => :'payment_schedule_type', 
    :'payment_amount_type' => :'payment_amount_type', 
    :'payment_reference' => :'payment_reference', 
    :'payment_entry_date' => :'payment_entry_date', 
    :'payment_return_date' => :'payment_return_date', 
    :'comments' => :'comments', 
    :'return_code' => :'return_code', 
    :'customer' => :'customer', 
    :'funding_account' => :'funding_account', 
    :'customer_account' => :'customer_account', 
    :'audit_info' => :'audit_info', 
    :'id_payment' => :'ID_PAYMENT' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/recorded_payment.rb', line 122

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

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 &&
      token == o.token &&
      confirmation_number == o.confirmation_number &&
      custom_fields == o.custom_fields &&
      currency_code3d == o.currency_code3d &&
      amount == o.amount &&
      payment_date == o.payment_date &&
      payment_schedule_type == o.payment_schedule_type &&
      payment_amount_type == o.payment_amount_type &&
      payment_reference == o.payment_reference &&
      payment_entry_date == o.payment_entry_date &&
      payment_return_date == o.payment_return_date &&
      comments == o.comments &&
      return_code == o.return_code &&
      customer == o.customer &&
       == o. &&
       == o. &&
      audit_info == o.audit_info &&
      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



377
378
379
380
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
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 377

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



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 456

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 356

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

Returns The Instance of RecordedPayment.

Returns:



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 291

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::RecordPaymentHandler.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) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

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:



259
260
261
262
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 259

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

Returns The Instance of RecordedPayment.

Returns:



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 265

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::DeleteRecordPaymentHandler.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) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

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:



243
244
245
246
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 243

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


343
344
345
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 343

def eql?(o)
  self == o
end

#for_client(client_key: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of String.

Returns:



159
160
161
162
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 159

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

#from_account(funding_account: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of FundingAccount.

Returns:



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

def (funding_account: nil)
    @funding_account = 
    self 
end

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

Returns The Instance of RecordedPayment.

Returns:



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 278

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::GetRecordPaymentHandler.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



349
350
351
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 349

def hash
  [id, url, fee, status, payment_method, token, confirmation_number, custom_fields, currency_code3d, amount, payment_date, payment_schedule_type, payment_amount_type, payment_reference, payment_entry_date, payment_return_date, comments, return_code, customer, , , audit_info, id_payment].hash
end

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

Returns The Instance of RecordedPayment.

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:



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

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 



305
306
307
308
309
310
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 305

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

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of CustomerAccount.

Returns:



200
201
202
203
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 200

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



435
436
437
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 435

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



441
442
443
444
445
446
447
448
449
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 441

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



429
430
431
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 429

def to_s
  to_hash.to_s
end

#vide_channel(channel: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of String.

Returns:



166
167
168
169
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 166

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

#with_custom_fields(custom_fields: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

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

Returns:



214
215
216
217
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 214

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

#with_customer(customer: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

  • customer (Customer) (defaults to: nil) —

    attribute in the form of Customer.

Returns:



235
236
237
238
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 235

def with_customer(customer: nil)
    @customer = customer
    self 
end

#with_details(payment_amount_type: nil, amount: nil, payment_date: nil, payment_method: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

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_method (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



176
177
178
179
180
181
182
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 176

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

#with_fee(fee: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of Fee.

Returns:



228
229
230
231
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 228

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

#with_memo(comments: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of String.

Returns:



221
222
223
224
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 221

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

#with_reference(payment_reference: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of String.

Returns:



207
208
209
210
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 207

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

#with_token(token: nil) ⇒ RecordedPayment

Returns The Instance of RecordedPayment.

Parameters:

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

    attribute in the form of String.

Returns:



193
194
195
196
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payment.rb', line 193

def with_token(token: nil)
    @token = token
    self 
end