Class: Io::Flow::V0::Models::RefundForm

Inherits:

Object

• Object
• Io::Flow::V0::Models::RefundForm

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

Refund actually transfers funds. You can refund as many times as you’d like up until the total amount of captured funds has been refunded. Note when creating a refund you can specify either an authorization id or a capture id (or both as long as they match).

Instance Attribute Summary

• #amount ⇒ Object readonly

  Returns the value of attribute amount.

• #authorization_id ⇒ Object readonly

  Returns the value of attribute authorization_id.

• #capture_id ⇒ Object readonly

  Returns the value of attribute capture_id.

• #currency ⇒ Object readonly

  Returns the value of attribute currency.

• #key ⇒ Object readonly

  Returns the value of attribute key.

Instance Method Summary

• #copy(incoming = {}) ⇒ Object
• #initialize(incoming = {}) ⇒ RefundForm constructor

  A new instance of RefundForm.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ RefundForm

Returns a new instance of RefundForm.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15276

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  @authorization_id = (x = opts.delete(:authorization_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('authorization_id', x, String))
  @capture_id = (x = opts.delete(:capture_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('capture_id', x, String))
  @key = (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, String))
  @amount = (x = opts.delete(:amount); x.nil? ? nil : HttpClient::Preconditions.assert_class('amount', HttpClient::Helper.to_big_decimal(x), BigDecimal))
  @currency = (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String))
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15274

def amount
  @amount
end

#authorization_id ⇒ Object (readonly)

Returns the value of attribute authorization_id.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15274

def authorization_id
  @authorization_id
end

#capture_id ⇒ Object (readonly)

Returns the value of attribute capture_id.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15274

def capture_id
  @capture_id
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15274

def currency
  @currency
end

#key ⇒ Object (readonly)

Returns the value of attribute key.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15274

def key
  @key
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15289

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

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15293

def to_hash
  {
    :authorization_id => authorization_id,
    :capture_id => capture_id,
    :key => key,
    :amount => amount,
    :currency => currency
  }
end

#to_json ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15285

def to_json
  JSON.dump(to_hash)
end