class Wire4Client::Payment

Attributes

account[RW]

Es la cuenta emisora.

amount[RW]

Es el monto de la transferencia.

beneficiary_account[RW]

Es la cuenta del beneficiario.

beneficiary_bank[RW]

Es la información del banco beneficiario.

beneficiary_name[RW]

Es el nombre del Beneficiario.

cep[RW]

Es el Comprobante Electrónico de Pago (CEP) emitido por Banxico de la transferencia. Sólo en caso de que este disponible en Banxico, posteriomente podrá usar la <a href="#operation/obtainTransactionCepUsingPOST">Consulta de CEP</a> que ésta misma API ofrece.

clave_rastreo[RW]

Es la clave de rastreo de la transferencia.

concept[RW]

Es el concepto de pago.

confirm_date[RW]

Es la fecha de aplicación de la transferencia. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>.

currency_code[RW]

Es el código de divisa de la transferencia. Es en el formato estándar de 3 dígitos. Ejemplo del peso mexicano: MXP, ejemplo del dólar estadounidense: USD.

detention_message[RW]

Es el mensaje proporcionado por Monex para la transferencia.

error_message[RW]

Es el mensaje de error, en caso de algún error se informará aquí.

monex_description[RW]

Es la descripción de Monex.

order_id[RW]

Es el identificador asignado por la aplciación a la transferencia.

payment_order_id[RW]

Es el identificador de la orden de pago en Monex.

pending_reason[RW]

Es la razón de porque esta pendiente aún cuando se autorizó la transferencia.

reference[RW]

Es la referencia numérica.

status_code[RW]

Es el estado de la transferencia de la transferencia, los posibles valores son: PENDING, COMPLETED, FAILED, CANCELLED

transaction_id[RW]

Es el identificador de la transferencia asignado por Monex.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/wire4_client/models/payment.rb, line 75
def self.attribute_map
  {
    :'account' => :'account',
    :'amount' => :'amount',
    :'beneficiary_account' => :'beneficiary_account',
    :'beneficiary_bank' => :'beneficiary_bank',
    :'beneficiary_name' => :'beneficiary_name',
    :'cep' => :'cep',
    :'clave_rastreo' => :'clave_rastreo',
    :'concept' => :'concept',
    :'confirm_date' => :'confirm_date',
    :'currency_code' => :'currency_code',
    :'detention_message' => :'detention_message',
    :'error_message' => :'error_message',
    :'monex_description' => :'monex_description',
    :'order_id' => :'order_id',
    :'payment_order_id' => :'payment_order_id',
    :'pending_reason' => :'pending_reason',
    :'reference' => :'reference',
    :'status_code' => :'status_code',
    :'transaction_id' => :'transaction_id'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/wire4_client/models/payment.rb, line 126
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account')
    self.account = attributes[:'account']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'beneficiary_account')
    self.beneficiary_account = attributes[:'beneficiary_account']
  end

  if attributes.has_key?(:'beneficiary_bank')
    self.beneficiary_bank = attributes[:'beneficiary_bank']
  end

  if attributes.has_key?(:'beneficiary_name')
    self.beneficiary_name = attributes[:'beneficiary_name']
  end

  if attributes.has_key?(:'cep')
    self.cep = attributes[:'cep']
  end

  if attributes.has_key?(:'clave_rastreo')
    self.clave_rastreo = attributes[:'clave_rastreo']
  end

  if attributes.has_key?(:'concept')
    self.concept = attributes[:'concept']
  end

  if attributes.has_key?(:'confirm_date')
    self.confirm_date = attributes[:'confirm_date']
  end

  if attributes.has_key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

  if attributes.has_key?(:'detention_message')
    self.detention_message = attributes[:'detention_message']
  end

  if attributes.has_key?(:'error_message')
    self.error_message = attributes[:'error_message']
  end

  if attributes.has_key?(:'monex_description')
    self.monex_description = attributes[:'monex_description']
  end

  if attributes.has_key?(:'order_id')
    self.order_id = attributes[:'order_id']
  end

  if attributes.has_key?(:'payment_order_id')
    self.payment_order_id = attributes[:'payment_order_id']
  end

  if attributes.has_key?(:'pending_reason')
    self.pending_reason = attributes[:'pending_reason']
  end

  if attributes.has_key?(:'reference')
    self.reference = attributes[:'reference']
  end

  if attributes.has_key?(:'status_code')
    self.status_code = attributes[:'status_code']
  end

  if attributes.has_key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/wire4_client/models/payment.rb, line 100
def self.swagger_types
  {
    :'account' => :'String',
    :'amount' => :'Float',
    :'beneficiary_account' => :'String',
    :'beneficiary_bank' => :'Institution',
    :'beneficiary_name' => :'String',
    :'cep' => :'MessageCEP',
    :'clave_rastreo' => :'String',
    :'concept' => :'String',
    :'confirm_date' => :'DateTime',
    :'currency_code' => :'String',
    :'detention_message' => :'String',
    :'error_message' => :'String',
    :'monex_description' => :'String',
    :'order_id' => :'String',
    :'payment_order_id' => :'Integer',
    :'pending_reason' => :'String',
    :'reference' => :'Integer',
    :'status_code' => :'String',
    :'transaction_id' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/wire4_client/models/payment.rb, line 224
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account == o.account &&
      amount == o.amount &&
      beneficiary_account == o.beneficiary_account &&
      beneficiary_bank == o.beneficiary_bank &&
      beneficiary_name == o.beneficiary_name &&
      cep == o.cep &&
      clave_rastreo == o.clave_rastreo &&
      concept == o.concept &&
      confirm_date == o.confirm_date &&
      currency_code == o.currency_code &&
      detention_message == o.detention_message &&
      error_message == o.error_message &&
      monex_description == o.monex_description &&
      order_id == o.order_id &&
      payment_order_id == o.payment_order_id &&
      pending_reason == o.pending_reason &&
      reference == o.reference &&
      status_code == o.status_code &&
      transaction_id == o.transaction_id
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/wire4_client/models/payment.rb, line 284
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
    temp_model = Wire4Client.const_get(type).new
    temp_model.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/wire4_client/models/payment.rb, line 350
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/wire4_client/models/payment.rb, line 263
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)
        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/wire4_client/models/payment.rb, line 250
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/wire4_client/models/payment.rb, line 256
def hash
  [account, amount, beneficiary_account, beneficiary_bank, beneficiary_name, cep, clave_rastreo, concept, confirm_date, currency_code, detention_message, error_message, monex_description, order_id, payment_order_id, pending_reason, reference, status_code, transaction_id].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/wire4_client/models/payment.rb, line 211
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/wire4_client/models/payment.rb, line 330
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/wire4_client/models/payment.rb, line 336
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() click to toggle source

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

# File lib/wire4_client/models/payment.rb, line 324
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/wire4_client/models/payment.rb, line 218
def valid?
  true
end