Class: Io::Flow::V0::Models::PaymentReversal

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

A reversal is used to release the remaining authorization hold for a payment request. When a reversal is processed, this indicates that the funds in question were never withdrawn from the customer’s account.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ PaymentReversal

Returns a new instance of PaymentReversal.



54492
54493
54494
54495
54496
54497
54498
54499
54500
54501
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54492

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :amount, :currency, :created_at, :updated_at, :status], 'PaymentReversal')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @amount = HttpClient::Preconditions.assert_class('amount', HttpClient::Helper.to_big_decimal(opts.delete(:amount)), BigDecimal)
  @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
  @created_at = HttpClient::Preconditions.assert_class('created_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:created_at)), DateTime)
  @updated_at = HttpClient::Preconditions.assert_class('updated_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:updated_at)), DateTime)
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::PaymentReversalStatus) ? x : ::Io::Flow::V0::Models::PaymentReversalStatus.new(x))
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



54490
54491
54492
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54490

def amount
  @amount
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



54490
54491
54492
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54490

def created_at
  @created_at
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



54490
54491
54492
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54490

def currency
  @currency
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



54490
54491
54492
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54490

def id
  @id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



54490
54491
54492
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54490

def status
  @status
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



54490
54491
54492
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54490

def updated_at
  @updated_at
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



54507
54508
54509
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54507

def copy(incoming={})
  PaymentReversal.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



54511
54512
54513
54514
54515
54516
54517
54518
54519
54520
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54511

def to_hash
  {
    :id => id,
    :amount => amount.to_f.to_s,
    :currency => currency,
    :created_at => created_at,
    :updated_at => updated_at,
    :status => status.to_hash
  }
end

#to_json ⇒ Object 



54503
54504
54505
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 54503

def to_json
  JSON.dump(to_hash)
end