Class: CyberSource::Ptsv2paymentsProcessingInformationBankTransferOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsProcessingInformationBankTransferOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
106
107
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#customer_memo ⇒ Object

Payment related information. This information is included on the customer’s statement.



36
37
38
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 36

def customer_memo
  @customer_memo
end

#customer_present ⇒ Object

Indicates whether a customer is physically present and whether the customer is enrolling in CyberSource Recurring Billing. Possible values: - ‘1`: Customer is present and not enrolling. - `2`: Customer is not present and not enrolling. - `3`: Customer is present and enrolling. - `4`: Customer is not present and enrolling.



48
49
50
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 48

def customer_present
  @customer_present
end

#decline_avs_flags ⇒ Object

Space-separated list of AVS flags that cause the request to be declined for AVS reasons. Important To receive declines for the AVS code ‘N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing Note CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |— |— | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. or Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS or System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors Note The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. Note For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer’s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: ‘B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |— |— | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match or (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. or The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type or AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.|



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

def decline_avs_flags
  @decline_avs_flags
end

#effective_date ⇒ Object

Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: ‘MMDDYYYY` Supported only for the CyberSource ACH Service.



30
31
32
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 30

def effective_date
  @effective_date
end

#fraud_screening_level ⇒ Object

Level of fraud screening. Possible values: - ‘1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see "Verification and Validation" in the [Electronic Check Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).



45
46
47
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 45

def fraud_screening_level
  @fraud_screening_level
end

#partial_payment_id ⇒ Object

Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see ‘partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)



33
34
35
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 33

def partial_payment_id
  @partial_payment_id
end

#payment_category_code ⇒ Object

Flag that indicates whether to process the payment. Use with deferred payments. For details, see ‘ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) Possible values: - `0`: Standard debit with immediate payment (default). - `1`: For deferred payments, indicates that this is a deferred payment and that you will send a debit request with `paymentCategoryCode = 2` in the future. - `2`: For deferred payments, indicates notification to initiate payment. #### Chase Paymentech Solutions and TeleCheck Use for deferred and partial payments. #### CyberSource ACH Service Not used. #### RBS WorldPay Atlanta Not used.



39
40
41
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 39

def payment_category_code
  @payment_category_code
end

#sec_code ⇒ Object

Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - ‘ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)



21
22
23
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 21

def sec_code
  @sec_code
end

#settlement_method ⇒ Object

Method used for settlement. Possible values: - ‘A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)



42
43
44
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 42

def settlement_method
  @settlement_method
end

#terminal_city ⇒ Object

City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.



24
25
26
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 24

def terminal_city
  @terminal_city
end

#terminal_state ⇒ Object

State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.



27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 27

def terminal_state
  @terminal_state
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 51

def self.attribute_map
  {
    :'decline_avs_flags' => :'declineAvsFlags',
    :'sec_code' => :'secCode',
    :'terminal_city' => :'terminalCity',
    :'terminal_state' => :'terminalState',
    :'effective_date' => :'effectiveDate',
    :'partial_payment_id' => :'partialPaymentId',
    :'customer_memo' => :'customerMemo',
    :'payment_category_code' => :'paymentCategoryCode',
    :'settlement_method' => :'settlementMethod',
    :'fraud_screening_level' => :'fraudScreeningLevel',
    :'customer_present' => :'customerPresent'
  }
end

.json_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 68

def self.json_map
  {
    :'decline_avs_flags' => :'decline_avs_flags',
    :'sec_code' => :'sec_code',
    :'terminal_city' => :'terminal_city',
    :'terminal_state' => :'terminal_state',
    :'effective_date' => :'effective_date',
    :'partial_payment_id' => :'partial_payment_id',
    :'customer_memo' => :'customer_memo',
    :'payment_category_code' => :'payment_category_code',
    :'settlement_method' => :'settlement_method',
    :'fraud_screening_level' => :'fraud_screening_level',
    :'customer_present' => :'customer_present'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 85

def self.swagger_types
  {
    :'decline_avs_flags' => :'String',
    :'sec_code' => :'String',
    :'terminal_city' => :'String',
    :'terminal_state' => :'String',
    :'effective_date' => :'String',
    :'partial_payment_id' => :'String',
    :'customer_memo' => :'String',
    :'payment_category_code' => :'String',
    :'settlement_method' => :'String',
    :'fraud_screening_level' => :'String',
    :'customer_present' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      decline_avs_flags == o.decline_avs_flags &&
      sec_code == o.sec_code &&
      terminal_city == o.terminal_city &&
      terminal_state == o.terminal_state &&
      effective_date == o.effective_date &&
      partial_payment_id == o.partial_payment_id &&
      customer_memo == o.customer_memo &&
      payment_category_code == o.payment_category_code &&
      settlement_method == o.settlement_method &&
      fraud_screening_level == o.fraud_screening_level &&
      customer_present == o.customer_present
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



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
321
322
323
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 287

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 353

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 266

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


253
254
255
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 259

def hash
  [decline_avs_flags, sec_code, terminal_city, terminal_state, effective_date, partial_payment_id, customer_memo, payment_category_code, settlement_method, fraud_screening_level, customer_present].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



156
157
158
159
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 156

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



333
334
335
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 333

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



339
340
341
342
343
344
345
346
347
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 339

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



327
328
329
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 327

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



163
164
165
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb', line 163

def valid?
  true
end