Class: Wire4Client::Payment

Inherits:
Object
  • Object
show all
Defined in:
lib/wire4_client/models/payment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Payment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# 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. = attributes[:'account']
  end

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

  if attributes.has_key?(:'beneficiary_account')
    self. = 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

Instance Attribute Details

#account ⇒ Object

Es la cuenta emisora.



18
19
20
 
# File 'lib/wire4_client/models/payment.rb', line 18

def 
  @account
end

#amount ⇒ Object

Es el monto de la transferencia.



21
22
23
 
# File 'lib/wire4_client/models/payment.rb', line 21

def amount
  @amount
end

#beneficiary_account ⇒ Object

Es la cuenta del beneficiario.



24
25
26
 
# File 'lib/wire4_client/models/payment.rb', line 24

def 
  @beneficiary_account
end

#beneficiary_bank ⇒ Object

Es la información del banco beneficiario.



27
28
29
 
# File 'lib/wire4_client/models/payment.rb', line 27

def beneficiary_bank
  @beneficiary_bank
end

#beneficiary_name ⇒ Object

Es el nombre del Beneficiario.



30
31
32
 
# File 'lib/wire4_client/models/payment.rb', line 30

def beneficiary_name
  @beneficiary_name
end

#cep ⇒ Object

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.



33
34
35
 
# File 'lib/wire4_client/models/payment.rb', line 33

def cep
  @cep
end

#clave_rastreo ⇒ Object

Es la clave de rastreo de la transferencia.



36
37
38
 
# File 'lib/wire4_client/models/payment.rb', line 36

def clave_rastreo
  @clave_rastreo
end

#concept ⇒ Object

Es el concepto de pago.



39
40
41
 
# File 'lib/wire4_client/models/payment.rb', line 39

def concept
  @concept
end

#confirm_date ⇒ Object

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



42
43
44
 
# File 'lib/wire4_client/models/payment.rb', line 42

def confirm_date
  @confirm_date
end

#currency_code ⇒ Object

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.



45
46
47
 
# File 'lib/wire4_client/models/payment.rb', line 45

def currency_code
  @currency_code
end

#detention_message ⇒ Object

Es el mensaje proporcionado por Monex para la transferencia.



48
49
50
 
# File 'lib/wire4_client/models/payment.rb', line 48

def detention_message
  @detention_message
end

#error_message ⇒ Object

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



51
52
53
 
# File 'lib/wire4_client/models/payment.rb', line 51

def error_message
  @error_message
end

#monex_description ⇒ Object

Es la descripción de Monex.



54
55
56
 
# File 'lib/wire4_client/models/payment.rb', line 54

def monex_description
  @monex_description
end

#order_id ⇒ Object

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



57
58
59
 
# File 'lib/wire4_client/models/payment.rb', line 57

def order_id
  @order_id
end

#payment_order_id ⇒ Object

Es el identificador de la orden de pago en Monex.



60
61
62
 
# File 'lib/wire4_client/models/payment.rb', line 60

def payment_order_id
  @payment_order_id
end

#pending_reason ⇒ Object

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



63
64
65
 
# File 'lib/wire4_client/models/payment.rb', line 63

def pending_reason
  @pending_reason
end

#reference ⇒ Object

Es la referencia numérica.



66
67
68
 
# File 'lib/wire4_client/models/payment.rb', line 66

def reference
  @reference
end

#status_code ⇒ Object

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



69
70
71
 
# File 'lib/wire4_client/models/payment.rb', line 69

def status_code
  @status_code
end

#transaction_id ⇒ Object

Es el identificador de la transferencia asignado por Monex.



72
73
74
 
# File 'lib/wire4_client/models/payment.rb', line 72

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/wire4_client/models/payment.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
       == o. &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# 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) ⇒ Hash

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


250
251
252
 
# File 'lib/wire4_client/models/payment.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/wire4_client/models/payment.rb', line 256

def hash
  [, amount, , 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



211
212
213
214
 
# File 'lib/wire4_client/models/payment.rb', line 211

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



330
331
332
 
# File 'lib/wire4_client/models/payment.rb', line 330

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



336
337
338
339
340
341
342
343
344
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



324
325
326
 
# File 'lib/wire4_client/models/payment.rb', line 324

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



218
219
220
 
# File 'lib/wire4_client/models/payment.rb', line 218

def valid?
  true
end