Class: CyberSource::Ptsv2payoutsSenderInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2payoutsSenderInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

def 
  @account
end

#address1 ⇒ Object

Street address of sender. **Funds Disbursement** This value is the address of the originator sending the funds disbursement.



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

def address1
  @address1
end

#administrative_area ⇒ Object

Sender’s state. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).



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

def administrative_area
  @administrative_area
end

#country_code ⇒ Object

Country of sender. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). * CTV (3)



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

def country_code
  @country_code
end

#date_of_birth ⇒ Object

Sender’s date of birth in YYYYMMDD format. Required only for FDCCompass.



56
57
58
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 56

def date_of_birth
  @date_of_birth
end

#first_name ⇒ Object

First name of sender (Optional). * CTV (14) * Paymentech (30)



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

def first_name
  @first_name
end

#identification_number ⇒ Object

#### Visa Platform Connect This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender.



68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 68

def identification_number
  @identification_number
end

#last_name ⇒ Object

Recipient last name (Optional). * CTV (14) * Paymentech (30)



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

def last_name
  @last_name
end

#locality ⇒ Object

City of sender. **Funds Disbursement** This value is the city of the originator sending the funds disbursement.



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

def locality
  @locality
end

#middle_initial ⇒ Object

Recipient middle initial (Optional).



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

def middle_initial
  @middle_initial
end

#middle_name ⇒ Object

Sender’s middle name. This field is a passthrough, 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.



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

def middle_name
  @middle_name
end

#name ⇒ Object

Name of sender. **Funds Disbursement** This value is the name of the originator sending the funds disbursement. * CTV, Paymentech (30)



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

def name
  @name
end

#personal_id_type ⇒ Object

#### Visa Platform Connect This tag will contain the type of sender identification. The valid values are: • BTHD (Date of birth) • CUID (Customer identification (unspecified)) • NTID (National identification) • PASN (Passport number) • DRLN (Driver license) • TXIN (Tax identification) • CPNY (Company registration number) • PRXY (Proxy identification) • SSNB (Social security number) • ARNB (Alien registration number) • LAWE (Law enforcement identification) • MILI (Military identification) • TRVL (Travel identification (non-passport)) • EMAL (Email) • PHON (Phone number)



62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 62

def personal_id_type
  @personal_id_type
end

#phone_number ⇒ Object

Sender’s phone number. Required only for FDCCompass.



53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 53

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Sender’s postal code. Required only for FDCCompass.



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

def postal_code
  @postal_code
end

#reference_number ⇒ Object

Reference number generated by you that uniquely identifies the sender.



18
19
20
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 18

def reference_number
  @reference_number
end

#type ⇒ Object

#### Visa Platform Connect This tag will denote whether the tax ID is a business or individual tax ID when personal ID Type contains the value of TXIN (Tax identification). The valid values are: • B (Business) • I (Individual)



65
66
67
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 65

def type
  @type
end

#vat_registration_number ⇒ Object

Customer’s government-assigned tax identification number.



59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 59

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 71

def self.attribute_map
  {
    :'reference_number' => :'referenceNumber',
    :'account' => :'account',
    :'first_name' => :'firstName',
    :'middle_initial' => :'middleInitial',
    :'middle_name' => :'middleName',
    :'last_name' => :'lastName',
    :'name' => :'name',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'administrative_area' => :'administrativeArea',
    :'country_code' => :'countryCode',
    :'postal_code' => :'postalCode',
    :'phone_number' => :'phoneNumber',
    :'date_of_birth' => :'dateOfBirth',
    :'vat_registration_number' => :'vatRegistrationNumber',
    :'personal_id_type' => :'personalIdType',
    :'type' => :'type',
    :'identification_number' => :'identificationNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 95

def self.swagger_types
  {
    :'reference_number' => :'String',
    :'account' => :'Ptsv2payoutsSenderInformationAccount',
    :'first_name' => :'String',
    :'middle_initial' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'name' => :'String',
    :'address1' => :'String',
    :'locality' => :'String',
    :'administrative_area' => :'String',
    :'country_code' => :'String',
    :'postal_code' => :'String',
    :'phone_number' => :'String',
    :'date_of_birth' => :'String',
    :'vat_registration_number' => :'String',
    :'personal_id_type' => :'String',
    :'type' => :'String',
    :'identification_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference_number == o.reference_number &&
       == o. &&
      first_name == o.first_name &&
      middle_initial == o.middle_initial &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      name == o.name &&
      address1 == o.address1 &&
      locality == o.locality &&
      administrative_area == o.administrative_area &&
      country_code == o.country_code &&
      postal_code == o.postal_code &&
      phone_number == o.phone_number &&
      date_of_birth == o.date_of_birth &&
      vat_registration_number == o.vat_registration_number &&
      personal_id_type == o.personal_id_type &&
      type == o.type &&
      identification_number == o.identification_number
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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 375

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 441

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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 354

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


341
342
343
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 341

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



347
348
349
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 347

def hash
  [reference_number, , first_name, middle_initial, middle_name, last_name, name, address1, locality, administrative_area, country_code, postal_code, phone_number, date_of_birth, vat_registration_number, personal_id_type, type, identification_number].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



201
202
203
204
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 201

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



421
422
423
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 421

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



427
428
429
430
431
432
433
434
435
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 427

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



415
416
417
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 415

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



208
209
210
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb', line 208

def valid?
  true
end