class VeloPayments::PayorAmlTransactionV3

Attributes

credit[RW]
credit_currency[RW]

ISO 4217 3 character currency code

date_funding_requested[RW]
debit[RW]
debit_currency[RW]

ISO 4217 3 character currency code

funding_type[RW]
fx_applied[RW]
payee_email[RW]
payee_name[RW]
payee_type[RW]
payment_amount[RW]
payment_currency[RW]

ISO 4217 3 character currency code

payment_memo[RW]
payment_rails[RW]
payment_status[RW]
payment_type[RW]
payor_payment_id[RW]
reject_reason[RW]
remote_id[RW]

Remote ID of the Payee, set by Payor

report_transaction_type[RW]
return_code[RW]
return_description[RW]
return_fee[RW]
return_fee_currency[RW]

ISO 4217 3 character currency code

return_fee_description[RW]
source_account[RW]
transaction_date[RW]
transaction_time[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 79
def self.attribute_map
  {
    :'transaction_date' => :'transactionDate',
    :'transaction_time' => :'transactionTime',
    :'report_transaction_type' => :'reportTransactionType',
    :'debit' => :'debit',
    :'debit_currency' => :'debitCurrency',
    :'credit' => :'credit',
    :'credit_currency' => :'creditCurrency',
    :'return_fee' => :'returnFee',
    :'return_fee_currency' => :'returnFeeCurrency',
    :'return_fee_description' => :'returnFeeDescription',
    :'return_code' => :'returnCode',
    :'return_description' => :'returnDescription',
    :'funding_type' => :'fundingType',
    :'date_funding_requested' => :'dateFundingRequested',
    :'payee_name' => :'payeeName',
    :'remote_id' => :'remoteId',
    :'payee_type' => :'payeeType',
    :'payee_email' => :'payeeEmail',
    :'source_account' => :'sourceAccount',
    :'payment_amount' => :'paymentAmount',
    :'payment_currency' => :'paymentCurrency',
    :'payment_memo' => :'paymentMemo',
    :'payment_type' => :'paymentType',
    :'payment_rails' => :'paymentRails',
    :'payor_payment_id' => :'payorPaymentId',
    :'payment_status' => :'paymentStatus',
    :'reject_reason' => :'rejectReason',
    :'fx_applied' => :'fxApplied'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 343
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 154
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PayorAmlTransactionV3` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::PayorAmlTransactionV3`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'transaction_date')
    self.transaction_date = attributes[:'transaction_date']
  end

  if attributes.key?(:'transaction_time')
    self.transaction_time = attributes[:'transaction_time']
  end

  if attributes.key?(:'report_transaction_type')
    self.report_transaction_type = attributes[:'report_transaction_type']
  end

  if attributes.key?(:'debit')
    self.debit = attributes[:'debit']
  end

  if attributes.key?(:'debit_currency')
    self.debit_currency = attributes[:'debit_currency']
  end

  if attributes.key?(:'credit')
    self.credit = attributes[:'credit']
  end

  if attributes.key?(:'credit_currency')
    self.credit_currency = attributes[:'credit_currency']
  end

  if attributes.key?(:'return_fee')
    self.return_fee = attributes[:'return_fee']
  end

  if attributes.key?(:'return_fee_currency')
    self.return_fee_currency = attributes[:'return_fee_currency']
  end

  if attributes.key?(:'return_fee_description')
    self.return_fee_description = attributes[:'return_fee_description']
  end

  if attributes.key?(:'return_code')
    self.return_code = attributes[:'return_code']
  end

  if attributes.key?(:'return_description')
    self.return_description = attributes[:'return_description']
  end

  if attributes.key?(:'funding_type')
    self.funding_type = attributes[:'funding_type']
  end

  if attributes.key?(:'date_funding_requested')
    self.date_funding_requested = attributes[:'date_funding_requested']
  end

  if attributes.key?(:'payee_name')
    self.payee_name = attributes[:'payee_name']
  end

  if attributes.key?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

  if attributes.key?(:'payee_type')
    self.payee_type = attributes[:'payee_type']
  end

  if attributes.key?(:'payee_email')
    self.payee_email = attributes[:'payee_email']
  end

  if attributes.key?(:'source_account')
    self.source_account = attributes[:'source_account']
  end

  if attributes.key?(:'payment_amount')
    self.payment_amount = attributes[:'payment_amount']
  end

  if attributes.key?(:'payment_currency')
    self.payment_currency = attributes[:'payment_currency']
  end

  if attributes.key?(:'payment_memo')
    self.payment_memo = attributes[:'payment_memo']
  end

  if attributes.key?(:'payment_type')
    self.payment_type = attributes[:'payment_type']
  end

  if attributes.key?(:'payment_rails')
    self.payment_rails = attributes[:'payment_rails']
  end

  if attributes.key?(:'payor_payment_id')
    self.payor_payment_id = attributes[:'payor_payment_id']
  end

  if attributes.key?(:'payment_status')
    self.payment_status = attributes[:'payment_status']
  end

  if attributes.key?(:'reject_reason')
    self.reject_reason = attributes[:'reject_reason']
  end

  if attributes.key?(:'fx_applied')
    self.fx_applied = attributes[:'fx_applied']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 147
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 113
def self.openapi_types
  {
    :'transaction_date' => :'Date',
    :'transaction_time' => :'String',
    :'report_transaction_type' => :'String',
    :'debit' => :'Integer',
    :'debit_currency' => :'String',
    :'credit' => :'Integer',
    :'credit_currency' => :'String',
    :'return_fee' => :'String',
    :'return_fee_currency' => :'String',
    :'return_fee_description' => :'String',
    :'return_code' => :'String',
    :'return_description' => :'String',
    :'funding_type' => :'String',
    :'date_funding_requested' => :'String',
    :'payee_name' => :'String',
    :'remote_id' => :'String',
    :'payee_type' => :'String',
    :'payee_email' => :'String',
    :'source_account' => :'String',
    :'payment_amount' => :'Integer',
    :'payment_currency' => :'String',
    :'payment_memo' => :'String',
    :'payment_type' => :'String',
    :'payment_rails' => :'String',
    :'payor_payment_id' => :'String',
    :'payment_status' => :'String',
    :'reject_reason' => :'String',
    :'fx_applied' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 295
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transaction_date == o.transaction_date &&
      transaction_time == o.transaction_time &&
      report_transaction_type == o.report_transaction_type &&
      debit == o.debit &&
      debit_currency == o.debit_currency &&
      credit == o.credit &&
      credit_currency == o.credit_currency &&
      return_fee == o.return_fee &&
      return_fee_currency == o.return_fee_currency &&
      return_fee_description == o.return_fee_description &&
      return_code == o.return_code &&
      return_description == o.return_description &&
      funding_type == o.funding_type &&
      date_funding_requested == o.date_funding_requested &&
      payee_name == o.payee_name &&
      remote_id == o.remote_id &&
      payee_type == o.payee_type &&
      payee_email == o.payee_email &&
      source_account == o.source_account &&
      payment_amount == o.payment_amount &&
      payment_currency == o.payment_currency &&
      payment_memo == o.payment_memo &&
      payment_type == o.payment_type &&
      payment_rails == o.payment_rails &&
      payor_payment_id == o.payor_payment_id &&
      payment_status == o.payment_status &&
      reject_reason == o.reject_reason &&
      fx_applied == o.fx_applied
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 371
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  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
    VeloPayments.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 440
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 350
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 330
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 336
def hash
  [transaction_date, transaction_time, report_transaction_type, debit, debit_currency, credit, credit_currency, return_fee, return_fee_currency, return_fee_description, return_code, return_description, funding_type, date_funding_requested, payee_name, remote_id, payee_type, payee_email, source_account, payment_amount, payment_currency, payment_memo, payment_type, payment_rails, payor_payment_id, payment_status, reject_reason, fx_applied].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 282
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 416
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 422
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 410
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/velopayments/models/payor_aml_transaction_v3.rb, line 289
def valid?
  true
end