Class: CyberSource::Ptsv2paymentsRecipientInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsRecipientInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 108

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?(:'accountId')
    self. = attributes[:'accountId']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Identifier for the recipient’s account. **Applicable for Barclays AFT transactions only.** It is mandatory for both Visa and Mastercard AFT. For Visa, the field has a maximum length of 34 character. For Mastercard, the field has a maximum length of 50 character.



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 17

def 
  @account_id
end

#account_type ⇒ Object

Identifies the recipient’s account type. **Applicable for Barclays AFT transactions only.** This field is mandatory for Mastercard and not applicable for Visa AFT. Valid values are: - ‘00` for Other - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN) - `02` for International Bank Account Number (IBAN) - `03` for Card Account - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 20

def 
  @account_type
end

#address1 ⇒ Object

The street address of the recipient **Applicable for Barclays AFT transactions only.** This field is mandatory for Mastercard and not applicable for Visa AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to Barclays. The field has a maximum length of 50 characters. Values exceeding these limits will be truncated.



32
33
34
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 32

def address1
  @address1
end

#beneficiary_address ⇒ Object

Only for e-wallets: The ultimate beneficiary’s street address (street, zip code, city), excluding the country. Example: "Main street 1, 12345, Barcelona



50
51
52
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 50

def beneficiary_address
  @beneficiary_address
end

#beneficiary_id ⇒ Object

Only for e-wallets: ID, username, hash or anything uniquely identifying the ultimate beneficiary.



44
45
46
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 44

def beneficiary_id
  @beneficiary_id
end

#beneficiary_name ⇒ Object

Only for e-wallets: The ultimate beneficiary’s full name.



47
48
49
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 47

def beneficiary_name
  @beneficiary_name
end

#country ⇒ Object

The country associated with the address of the recipient. **Applicable for Barclays AFT transactions only.** This field is mandatory for Mastercard and not applicable for Visa AFT. Must be a two character ISO country code. For example, see [ISO Country Code](developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html)



38
39
40
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 38

def country
  @country
end

#date_of_birth ⇒ Object

Recipient’s date of birth. Format: ‘YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.



41
42
43
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 41

def date_of_birth
  @date_of_birth
end

#first_name ⇒ Object

First name of the recipient. **Applicable for Barclays AFT transactions only.** The field is mandatory for both Visa and Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. For Mastercard, the field has a maximum length of 35 characters. Values exceeding the above limits will be truncated.



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 23

def first_name
  @first_name
end

#last_name ⇒ Object

Last name of the recipient. **Applicable for Barclays AFT transactions only.** This field is optional for both Visa and Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. For Mastercard, the field has a maximum length of 35 characters. Values exceeding these limits will be truncated.



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 26

def last_name
  @last_name
end

#middle_name ⇒ Object

Middle name of the recipient. **Applicable for Barclays AFT transactions only.** This field is optional for both Visa and Mastercard AFT. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to Barclays. For Visa, the maximum length of First Name, Middle Name and Last Name is 30 characters. For Mastercard, the field has a maximum length of 1 character. Values exceeding these limits will be truncated.



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 29

def middle_name
  @middle_name
end

#postal_code ⇒ Object

Partial postal code for the recipient’s address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: NN5. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.



35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 35

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 53

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'account_type' => :'accountType',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'middle_name' => :'middleName',
    :'address1' => :'address1',
    :'postal_code' => :'postalCode',
    :'country' => :'country',
    :'date_of_birth' => :'dateOfBirth',
    :'beneficiary_id' => :'beneficiaryId',
    :'beneficiary_name' => :'beneficiaryName',
    :'beneficiary_address' => :'beneficiaryAddress'
  }
end

.json_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 71

def self.json_map
  {
    :'account_id' => :'account_id',
    :'account_type' => :'account_type',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'middle_name' => :'middle_name',
    :'address1' => :'address1',
    :'postal_code' => :'postal_code',
    :'country' => :'country',
    :'date_of_birth' => :'date_of_birth',
    :'beneficiary_id' => :'beneficiary_id',
    :'beneficiary_name' => :'beneficiary_name',
    :'beneficiary_address' => :'beneficiary_address'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 89

def self.swagger_types
  {
    :'account_id' => :'String',
    :'account_type' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'middle_name' => :'String',
    :'address1' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String',
    :'date_of_birth' => :'String',
    :'beneficiary_id' => :'String',
    :'beneficiary_name' => :'String',
    :'beneficiary_address' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 250

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      middle_name == o.middle_name &&
      address1 == o.address1 &&
      postal_code == o.postal_code &&
      country == o.country &&
      date_of_birth == o.date_of_birth &&
      beneficiary_id == o.beneficiary_id &&
      beneficiary_name == o.beneficiary_name &&
      beneficiary_address == o.beneficiary_address
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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 303

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 369

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 282

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


269
270
271
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 275

def hash
  [, , first_name, last_name, middle_name, address1, postal_code, country, date_of_birth, beneficiary_id, beneficiary_name, beneficiary_address].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



165
166
167
168
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 165

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



349
350
351
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 349

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



355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 355

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



343
344
345
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 343

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



172
173
174
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb', line 172

def valid?
  true
end