Class: CyberSource::Ptsv2paymentsProcessingInformationAuthorizationOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsProcessingInformationAuthorizationOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 173

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'ignoreAvsResult')
    self.ignore_avs_result = attributes[:'ignoreAvsResult']
  else
    self.ignore_avs_result = false
  end

  if attributes.has_key?(:'declineAvsFlags')
    if (value = attributes[:'declineAvsFlags']).is_a?(Array)
      self.decline_avs_flags = value
    end
  end

  if attributes.has_key?(:'ignoreCvResult')
    self.ignore_cv_result = attributes[:'ignoreCvResult']
  else
    self.ignore_cv_result = false
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aft_indicator ⇒ Object

Indicates whether the transaction is an Account Funding Transaction (AFT). This field is mandatory for Account Funding Transactions (AFT). Possible values: - ‘true` (This is an AFT transaction) - `false` (default value) (This is not an AFT transaction)



82
83
84
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 82

def aft_indicator
  @aft_indicator
end

#aggregated_auth_indicator ⇒ Object

Indicates if transaction is an aggregated auth Possible values: - true - false



64
65
66
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 64

def aggregated_auth_indicator
  @aggregated_auth_indicator
end

#auth_indicator ⇒ Object

Flag that specifies the purpose of the authorization. Possible values: - 0: Preauthorization - 1: Final authorization To set the default for this field, contact CyberSource Customer Support. #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file.



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

def auth_indicator
  @auth_indicator
end

#auth_type ⇒ Object

Authorization type. Possible values: - ‘AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. #### for PayPal ptsV2CreateOrderPost400Response Set this field to ’AUTHORIZE’ or ‘CAPTURE’ depending on whether you want to invoke delayed capture or sale respectively.



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

def auth_type
  @auth_type
end

#balance_inquiry ⇒ Object

Flag that indicates whether to return balance information. Possible values: - ‘true`: Return balance information. - `false`: Do not return balance information. #### Used by Authorization Required for a balance inquiry; otherwise, not used. #### PIN debit Required for a balance inquiry request of a PIN debit purchase; otherwise, not used.



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

def balance_inquiry
  @balance_inquiry
end

#bill_payment ⇒ Object

Indicates payment for bill or payment towards existing contractual loan. Possible values: - ‘true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. Optional request field.



52
53
54
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 52

def bill_payment
  @bill_payment
end

#bill_payment_type ⇒ Object

Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment - 005: Installment based repayment The value for this field corresponds to the following data in the TC 33A capture file (applicable to Brazil): - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier The value for this field corresponds to the following data in the TC 33A capture file (applicable to Installment) based Repayment): - Record: CP01 TCR6 - Position: 154-156 - Field: Bill Payment Transaction Type Identifier This field is supported for 1. Bill payments in Brazil with Mastercard on CyberSource through VisaNet. 2. Installment based repayment transactions on Cybersource through VisaNet.



55
56
57
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 55

def bill_payment_type
  @bill_payment_type
end

#card_verification_indicator ⇒ Object

This API field will indicate whether a card verification check is being performed during the transaction Possible values: - ‘true` - `false` (default value)



79
80
81
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 79

def card_verification_indicator
  @card_verification_indicator
end

#cash_advance_indicator ⇒ Object

This API field enables the merchant to indicate that a given transaction is Cash Advance. Cash advance or Cash disbursement functionality allows a merchant to dispense cash at a point of sale. It provides the ability of a POS system to act like an ATM. These terminals are typically seen in bank branches where customers can use their card and withdraw cash or at merchant locations where ATMs are sparse. Possible values: - ‘true` (Cash advance is supported) - `false` (default: cash advance is not supported)



73
74
75
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 73

def cash_advance_indicator
  @cash_advance_indicator
end

#debt_recovery_indicator ⇒ Object

Indicates if transaction is a debt recovery request Possible values: - true - false



67
68
69
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 67

def debt_recovery_indicator
  @debt_recovery_indicator
end

#decline_avs_flags ⇒ Object

Comma-separated list of AVS flags that cause the reply flag ‘DAVSNO` to be returned. Important To receive declines for the AVS code `N`, you must include the value `N` in the comma-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.<br/><br/> _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.|



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

def decline_avs_flags
  @decline_avs_flags
end

#deferred_auth_indicator ⇒ Object

Flag that indicates whether the authorization request was delayed because connectivity was interrupted. Possible values: - ‘true` (Deferred authorization) - `false` (default: Not a deferred authorization)



70
71
72
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 70

def deferred_auth_indicator
  @deferred_auth_indicator
end

#extend_auth_indicator ⇒ Object

Flag that indicates whether the transaction is an extended authorization.



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

def extend_auth_indicator
  @extend_auth_indicator
end

#ignore_avs_result ⇒ Object

Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives an AVS decline, as indicated by a reply flag value of DAVSNO. Possible values: - ‘true`: Ignore the results of AVS checking and run the capture service. - `false` (default): If the authorization receives an AVS decline, do not run the capture service. When the value of this field is `true`, the list in the `processingInformation.authorizationOptions.declineAvsFlags` field is ignored. #### Used by Authorization Optional field. String (3)



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

def ignore_avs_result
  @ignore_avs_result
end

#ignore_cv_result ⇒ Object

Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives a CVN decline, as indicated by an ‘processorInformation.cardVerification.resultCode` value of `D` or `N`. Possible values: - `true`: Ignore the results of CVN checking and run the capture service. - `false` (default): If the authorization receives a CVN decline, do not run the capture service. #### Used by Authorization Optional field.



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

def ignore_cv_result
  @ignore_cv_result
end

#initiator ⇒ Object

Returns the value of attribute initiator.



49
50
51
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 49

def initiator
  @initiator
end

#pan_return_indicator ⇒ Object

#### Visa Platform Connect The field contains the PAN translation indicator for American Express Contactless Transaction. Valid value is  1- Expresspay Translation, PAN request 2- Expresspay Translation, PAN and Expiry date request



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

def pan_return_indicator
  @pan_return_indicator
end

#partial_auth_indicator ⇒ Object

Flag that indicates whether the transaction is enabled for partial authorization. When the request includes this field, this value overrides the information in your account. Possible values: - ‘true`: Enable the transaction for partial authorization. - `false`: Do not enable the transaction for partial authorization. #### PIN debit Required field for partial authorizations that use PIN debit purchase; otherwise, not used. #### Used by Authorization Optional field. #### CyberSource through VisaNet To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators



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

def partial_auth_indicator
  @partial_auth_indicator
end

#redemption_inquiry ⇒ Object

Flag that indicates the payment request is a redemption inquiry. Possible values: - ‘true` - `false`



58
59
60
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 58

def redemption_inquiry
  @redemption_inquiry
end

#split_payment_transaction ⇒ Object

#### Visa Platform Connect Indicates split payment transaction. A split payment allows the use of two payment methods for a single transaction. Possible values: - ‘true` (split payment transaction is supported) - `false` (default: split payment transaction is not supported)



76
77
78
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 76

def split_payment_transaction
  @split_payment_transaction
end

#transportation_mode ⇒ Object

Type of transportation mode : Possible Values: - 00 = Unknown - 01 = Urban bus - 02 = Interurban bus - 03=Lighttrainmasstransit(Underground Metro LTR) - 04 = Train - 05 = Commuter train - 06 = Water-borne vehicle - 07 = Toll - 08 = Parking - 09 = Taxi - 10 = High-speed train - 11 = Rural bus - 12 = Express commuter train - 13 = Para transit - 14 = Self drive vehicle - 15 = Coach - 16 = Locomotive - 17 = Powered motor coach - 18 = Trailer - 19 = Regional train - 20 = Inter-city - 21 = Funicular train - 22 = Cable car



61
62
63
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 61

def transportation_mode
  @transportation_mode
end

#verbal_auth_code ⇒ Object

Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code.



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

def verbal_auth_code
  @verbal_auth_code
end

#verbal_auth_transaction_id ⇒ Object

Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of ‘000000000000000` (15 zeros).



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

def verbal_auth_transaction_id
  @verbal_auth_transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 85

def self.attribute_map
  {
    :'auth_type' => :'authType',
    :'pan_return_indicator' => :'panReturnIndicator',
    :'verbal_auth_code' => :'verbalAuthCode',
    :'verbal_auth_transaction_id' => :'verbalAuthTransactionId',
    :'auth_indicator' => :'authIndicator',
    :'partial_auth_indicator' => :'partialAuthIndicator',
    :'extend_auth_indicator' => :'extendAuthIndicator',
    :'balance_inquiry' => :'balanceInquiry',
    :'ignore_avs_result' => :'ignoreAvsResult',
    :'decline_avs_flags' => :'declineAvsFlags',
    :'ignore_cv_result' => :'ignoreCvResult',
    :'initiator' => :'initiator',
    :'bill_payment' => :'billPayment',
    :'bill_payment_type' => :'billPaymentType',
    :'redemption_inquiry' => :'redemptionInquiry',
    :'transportation_mode' => :'transportationMode',
    :'aggregated_auth_indicator' => :'aggregatedAuthIndicator',
    :'debt_recovery_indicator' => :'debtRecoveryIndicator',
    :'deferred_auth_indicator' => :'deferredAuthIndicator',
    :'cash_advance_indicator' => :'cashAdvanceIndicator',
    :'split_payment_transaction' => :'splitPaymentTransaction',
    :'card_verification_indicator' => :'cardVerificationIndicator',
    :'aft_indicator' => :'aftIndicator'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'auth_type' => :'auth_type',
    :'pan_return_indicator' => :'pan_return_indicator',
    :'verbal_auth_code' => :'verbal_auth_code',
    :'verbal_auth_transaction_id' => :'verbal_auth_transaction_id',
    :'auth_indicator' => :'auth_indicator',
    :'partial_auth_indicator' => :'partial_auth_indicator',
    :'extend_auth_indicator' => :'extend_auth_indicator',
    :'balance_inquiry' => :'balance_inquiry',
    :'ignore_avs_result' => :'ignore_avs_result',
    :'decline_avs_flags' => :'decline_avs_flags',
    :'ignore_cv_result' => :'ignore_cv_result',
    :'initiator' => :'initiator',
    :'bill_payment' => :'bill_payment',
    :'bill_payment_type' => :'bill_payment_type',
    :'redemption_inquiry' => :'redemption_inquiry',
    :'transportation_mode' => :'transportation_mode',
    :'aggregated_auth_indicator' => :'aggregated_auth_indicator',
    :'debt_recovery_indicator' => :'debt_recovery_indicator',
    :'deferred_auth_indicator' => :'deferred_auth_indicator',
    :'cash_advance_indicator' => :'cash_advance_indicator',
    :'split_payment_transaction' => :'split_payment_transaction',
    :'card_verification_indicator' => :'card_verification_indicator',
    :'aft_indicator' => :'aft_indicator'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'auth_type' => :'String',
    :'pan_return_indicator' => :'String',
    :'verbal_auth_code' => :'String',
    :'verbal_auth_transaction_id' => :'String',
    :'auth_indicator' => :'String',
    :'partial_auth_indicator' => :'BOOLEAN',
    :'extend_auth_indicator' => :'String',
    :'balance_inquiry' => :'BOOLEAN',
    :'ignore_avs_result' => :'BOOLEAN',
    :'decline_avs_flags' => :'Array<String>',
    :'ignore_cv_result' => :'BOOLEAN',
    :'initiator' => :'Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator',
    :'bill_payment' => :'BOOLEAN',
    :'bill_payment_type' => :'String',
    :'redemption_inquiry' => :'BOOLEAN',
    :'transportation_mode' => :'String',
    :'aggregated_auth_indicator' => :'String',
    :'debt_recovery_indicator' => :'String',
    :'deferred_auth_indicator' => :'BOOLEAN',
    :'cash_advance_indicator' => :'BOOLEAN',
    :'split_payment_transaction' => :'BOOLEAN',
    :'card_verification_indicator' => :'BOOLEAN',
    :'aft_indicator' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 323

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_type == o.auth_type &&
      pan_return_indicator == o.pan_return_indicator &&
      verbal_auth_code == o.verbal_auth_code &&
      verbal_auth_transaction_id == o.verbal_auth_transaction_id &&
      auth_indicator == o.auth_indicator &&
      partial_auth_indicator == o.partial_auth_indicator &&
      extend_auth_indicator == o.extend_auth_indicator &&
      balance_inquiry == o.balance_inquiry &&
      ignore_avs_result == o.ignore_avs_result &&
      decline_avs_flags == o.decline_avs_flags &&
      ignore_cv_result == o.ignore_cv_result &&
      initiator == o.initiator &&
      bill_payment == o.bill_payment &&
      bill_payment_type == o.bill_payment_type &&
      redemption_inquiry == o.redemption_inquiry &&
      transportation_mode == o.transportation_mode &&
      aggregated_auth_indicator == o.aggregated_auth_indicator &&
      debt_recovery_indicator == o.debt_recovery_indicator &&
      deferred_auth_indicator == o.deferred_auth_indicator &&
      cash_advance_indicator == o.cash_advance_indicator &&
      split_payment_transaction == o.split_payment_transaction &&
      card_verification_indicator == o.card_verification_indicator &&
      aft_indicator == o.aft_indicator
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



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
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 387

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 453

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



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

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


353
354
355
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 353

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



359
360
361
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 359

def hash
  [auth_type, pan_return_indicator, verbal_auth_code, verbal_auth_transaction_id, auth_indicator, partial_auth_indicator, extend_auth_indicator, balance_inquiry, ignore_avs_result, decline_avs_flags, ignore_cv_result, initiator, bill_payment, bill_payment_type, redemption_inquiry, transportation_mode, aggregated_auth_indicator, debt_recovery_indicator, deferred_auth_indicator, cash_advance_indicator, split_payment_transaction, card_verification_indicator, aft_indicator].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



280
281
282
283
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 280

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



433
434
435
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 433

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



439
440
441
442
443
444
445
446
447
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 439

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



427
428
429
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 427

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



287
288
289
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb', line 287

def valid?
  true
end